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

Modify setuptools and pip docs for OSX #466

Merged
merged 2 commits into from
Aug 8, 2014
Merged

Modify setuptools and pip docs for OSX #466

merged 2 commits into from
Aug 8, 2014

Conversation

mandarg
Copy link
Contributor

@mandarg mandarg commented Jul 28, 2014

Clarify a little more what setuptools allows you to do, what pip is, and what advantages it has over easy_install provided by Setuptools.

This makes the docs sound somewhat opinionated, but simplifies things a little for new users. If we mention Setuptools, easy_install should be mentioned at least; and then some information towards why a lot of people will say "just use pip!".

Let me know if some wording should be changed, or if you think the documentation as existing is better.

Clarify a little more what setuptools allows you to do, what pip is, and
what advantages it has.
@sigmavirus24
Copy link
Contributor

I'm fairly certain (although it's been a while and I could be wrong) that easy_install is present regardless of setuptools and is in fact provided by distutils. Assuming that's correct, then there's no need to mention it because we're mentioning setuptools. Further, I feel the documentation was better as it was written before with one caveat:

  1. The last sentence of the first paragraph should be removed. It is out of place and not in any way supposed to be part of that paragraph.

@mandarg
Copy link
Contributor Author

mandarg commented Jul 29, 2014

Setuptools' documentation says that they bundle easy_install (https://pythonhosted.org/setuptools/easy_install.html#using-easy-install). The distutils documentation does not include any description of installation using easy_install (https://docs.python.org/2/install/index.html#install-index).

Could you clarify whether this is correct? Perhaps I'm not seeing something correctly.

@kennethreitz
Copy link
Contributor

I believe easy_install is only available via setuptools/distribute.

@mandarg
Copy link
Contributor Author

mandarg commented Aug 7, 2014

@sigmavirus24 Does that clear up the inclusion of easy_install?

If you still think the documentation is better as-is, feel free to close the PR. Thanks! 🍰

Happily, when you ran ``brew install python``, Homebrew also installed **pip**.
Pip allows for installation and uninstallation of packages, and is actively
maintained.
Homebrew also installs Setuptools and `pip` for you.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove "also" from this sentence and use two backticks (`) around pip, e.g.,

``pip``

@sigmavirus24
Copy link
Contributor

@mandarg sorry for the confusion. There are just a couple of edits that I'd like you to make before I merge this. Thanks

@mandarg
Copy link
Contributor Author

mandarg commented Aug 8, 2014

No problem, put in the changes you suggested :)

@sigmavirus24
Copy link
Contributor

Looks good! I'll merge it in the morning

sigmavirus24 added a commit that referenced this pull request Aug 8, 2014
Modify setuptools and pip docs for OSX
@sigmavirus24 sigmavirus24 merged commit b787ec3 into realpython:master Aug 8, 2014
@sigmavirus24
Copy link
Contributor

Thanks @mandarg! 🍰

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.

3 participants