Skip to content

DOC: better installation instructions #474

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

Merged

Conversation

matthew-brett
Copy link
Member

Don't advise sudo, it's a terrible idea.

Make clear the difference between a "source" install and a "development"
install.

sudo python setup.py install
pip install --user .

or you work inside a virtualenv_.
Copy link
Member

Choose a reason for hiding this comment

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

+1 fwiw ;-)

@coveralls
Copy link

coveralls commented Aug 6, 2016

Coverage Status

Coverage remained the same at 96.227% when pulling 8476cb2 on matthew-brett:better-installation-advice into 22cef70 on nipy:master.


To run an extended test suite that validates ``nibabel`` for long-running and resource-intensive cases, please see :ref:`advanced_testing`.
To run an extended test suite that validates ``nibabel`` for long-running and
resource-intensive cases, please see :ref:`advanced_testing`.
Copy link
Member

Choose a reason for hiding this comment

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

I didn't know... Need to read on ;-)

@codecov-io
Copy link

codecov-io commented Aug 6, 2016

Current coverage is 94.24% (diff: 100%)

Merging #474 into master will not change coverage

@@             master       #474   diff @@
==========================================
  Files           161        161          
  Lines         21255      21255          
  Methods           0          0          
  Messages          0          0          
  Branches       2277       2277          
==========================================
  Hits          20032      20032          
  Misses          802        802          
  Partials        421        421          

Powered by Codecov. Last update 22cef70...24223f7

Don't advise sudo, it's a terrible idea.

Make clear the difference between a "source" install and a "development"
install.
@matthew-brett matthew-brett force-pushed the better-installation-advice branch from 8476cb2 to 24223f7 Compare August 6, 2016 21:31
@coveralls
Copy link

coveralls commented Aug 6, 2016

Coverage Status

Coverage remained the same at 96.227% when pulling 24223f7 on matthew-brett:better-installation-advice into 22cef70 on nipy:master.

@matthew-brett
Copy link
Member Author

I'm not sure what to make of the Donald Stufft article - I guess that we should expect requirements.txt to be used by developers, mainly.

The datalad idea as I understand it is to add full installation group, and then use the local development idea of the requirements.txt file to trigger that.

So, yes, maybe. I wish I had a clearer feeling for how requirements.txt is used in practice. But maybe Donald Stufft is right, that it is really only useful for people writing web apps with very strict requirements for deployment.

@yarikoptic
Copy link
Member

On Sat, 06 Aug 2016, Matthew Brett wrote:

I'm not sure what to make of the Donald Stufft article - I guess that we
should expect requirements.txt to be used by developers, mainly.

or more "to pin point specific versions in particular deployments"

The datalad idea as I understand it is to add full installation group, and
then use the local development idea of the requirements.txt file to
trigger that.

yeap. This way, for instance, pip install nibabel could install the
core of nibabel, and then additional pieces could be pulled in pip
install nibabel[dicom], or a full installation with everything
imaginable supported by nibabel via 'nibabel[full]'

@matthew-brett
Copy link
Member Author

OK to leave better requirements handling for a later PR?

@yarikoptic
Copy link
Member

if you mean "let's merge this one now and improve later with another PR", then +1 on my side ;)

@matthew-brett matthew-brett merged commit 3859dfa into nipy:master Aug 8, 2016
@matthew-brett matthew-brett deleted the better-installation-advice branch August 8, 2016 19:01
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