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

Remove ez_setup from documentation #1553

Merged
merged 8 commits into from Oct 28, 2018

Conversation

Projects
None yet
3 participants
@varunkamath18
Contributor

varunkamath18 commented Oct 28, 2018

Summary of changes

Split up previous "Installing setuptools" section into the following:

  1. Use link to pip installation instead of Easy install instructions
  2. Move "Custom installation instructions" to documentation for creating virtual environments.

Closes #1540

Pull Request Checklist

  • Changes have tests
  • News fragment added in changelog.d. See documentation for details

varunkamath18 added some commits Oct 28, 2018

Quick update.
Split the previous instructions into two parts:
1. Installing setuptools
2. Guiding to the creating virtual environments documentation
so that the user can custom install within the virtual environment.
.. _Creating Virtual Environments: https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments

This comment has been minimized.

@benoit-pierre

benoit-pierre Oct 28, 2018

Member

I don't think we need to mention the virtualenv thing, I'd just use something along those lines:

To install setuptools, use:

    pip install setuptools

Refer to the `Installing Packages`_ guide for more information.

My problem with those instructions is they don't use --user by default, and we really don't want users to use sudo pip to work around that...

This comment has been minimized.

@varunkamath18

varunkamath18 Oct 28, 2018

Contributor

Thanks, will make that change now.

varunkamath18 added some commits Oct 28, 2018

Include benoit's recommendations:
1. DO NOT link to documentation for creating virtual environments
because it doesn't recommend installing with --user option by default.
If you want the current in-development version of setuptools, you should first
install a stable version, and then run::
To install setuptools, use::

This comment has been minimized.

@pganssle

pganssle Oct 28, 2018

Member
Suggested change Beta
To install setuptools, use::
To install the latest version of setuptools, use::
This will download and install the latest development (i.e. unstable) version
of setuptools from the Python Subversion sandbox.
pip install setuptools

This comment has been minimized.

@pganssle

pganssle Oct 28, 2018

Member
Suggested change Beta
pip install setuptools
pip install -U setuptools
@pganssle

Approved with one minor change. Thanks!

@pganssle

This comment has been minimized.

Member

pganssle commented Oct 28, 2018

Oh actually, also this needs a changelog.

@pganssle pganssle merged commit 9ad8e0d into pypa:master Oct 28, 2018

5 checks passed

codecov/patch Coverage not affected when comparing 3c128c7...9fe6dba
Details
codecov/project 81.45% remains the same compared to 3c128c7
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
deploy/netlify Deploy preview ready!
Details

@pganssle pganssle referenced this pull request Oct 29, 2018

Merged

Update documentation for setuptools distribution #1560

1 of 1 task complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment