Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed setup.py and completely rewrote and tested installation docs (Fixes #1847) #1852

Merged
merged 27 commits into from
Jun 1, 2016

Conversation

HannesHolste
Copy link
Contributor

@HannesHolste HannesHolste commented May 28, 2016

20 hours later... dependency hell figured out!

See #1847.

Only minimal changes to setup.py made – mostly adding missing package definitions. The only changes to the python dependencies made were removing the moi version constraint and adding the coveralls package (because travis config specified it too).

These instructions were tested successfully on Mac OS X El Capitan 10.11.4 and a clean installation of Ubuntu 12.04 LTS (precise) using conda v4.0.7 and cloning from qiita master branch commit #a9e4e03 on 5/27/2016.

@coveralls
Copy link

Coverage Status

Changes Unknown when pulling 1d8135a on HannesHolste:install-docs into * on biocore:master*.

Qiita installation
==================

Qiita is pip installable, but depends on some non-python packages that must be installed first.
Qiita is pip installable, but depends on some non-python packages that must be installed first. We strongly recommend using virtual environments; the solution we recommend ot manage them is [miniconda](http://conda.pydata.org/miniconda.html), a lightweight version of the virtual environment, python distribution, and package manager anaconda.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if miniconda is the version we recommend ... I would say that is the version we will use in this manual. Note that we use virtualenv in all our internal installs.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we recommend ot -> we recommend to

This means `cookie_secret` is missing on the qiita configuration file `~/config_test.cfg`. Try updating it as per above instructions, or manually adding the missing key-value to the config file.

**Q: I get the error:** `Error: database "qiita_test" already exists`

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps add the instructions to drop it?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

qiita-env clean_test?

@antgonza
Copy link
Member

A few comments, thanks!


These instructions were tested successfully by [@HannesHolste](github.com/HannesHolste) on Mac OS X El Capitan 10.11.4 and a clean installation of Ubuntu 12.04 LTS (precise) using conda v4.0.7 and cloning from [qiita master branch commit #a9e4e03](https://github.com/biocore/qiita/commit/a9e4e03ecd781d3985abc03d15f2248143e565d7) on 5/27/2016.

## Install miniconda
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we point to the miniconda installation instructions? We should not be maintaining the way they install it, but make it easier for user to find the instructions

@josenavas
Copy link
Contributor

Thanks for working on this!

@coveralls
Copy link

Coverage Status

Changes Unknown when pulling 43ba771 on HannesHolste:install-docs into * on biocore:master*.


(When you want to deactivate this environment, e.g. to return to a different project or back to your global python and pip packages, run `source deactivate`)

After activating your new environment, you should see this kind of output when you run `which python`, indicating that the `python` command now refers to the python binary in your new virtual environment, rather than a previous global default such as `/usr/bin/python`. For example, assuming you installed miniconda in `Users/your_username/`:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users/ -> /Users/

@antgonza
Copy link
Member

A few more comments.

@HannesHolste
Copy link
Contributor Author

Cool, thank you for your feedback @antgonza and @josenavas, it's looking a lot better now!

@coveralls
Copy link

Coverage Status

Changes Unknown when pulling fca7f61 on HannesHolste:install-docs into * on biocore:master*.


As long as you are in the active qiita environment, commands such as `pip install` or `python` will refer to and be contained within this virtual environment.

When you want to deactivate your current condo environment, e.g. to return to a different project or back to your global python and pip packages, run:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

condo -> conda

@coveralls
Copy link

Coverage Status

Changes Unknown when pulling f03a3af on HannesHolste:install-docs into * on biocore:master*.

@HannesHolste HannesHolste changed the title Fixed setup.py and completely rewrote and tested installation docs Fixed setup.py and completely rewrote and tested installation docs (Fixes #1847) May 31, 2016
@HannesHolste
Copy link
Contributor Author

Fixed typo.

@antgonza

@josenavas
Copy link
Contributor

👍

@antgonza antgonza merged commit eb16b4e into qiita-spots:master Jun 1, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants