-
Notifications
You must be signed in to change notification settings - Fork 5.9k
Removed references to Setuptools/easy_install in favor of pip. #687
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
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
6711e7f
Removed references to Setuptools/easy_install in favor of pip. A new…
3047288
Removed references to main install page
8da905e
First stab at Python3 OS X docs
53a249a
Bad tick marks in virtualenv doc
9223381
Python3 stuff in virtualenv less prominent
ef3cc7e
Merge remote-tracking branch 'upstream/master'
328a261
Re-instated references to setuptools
e7ca528
Merge remote-tracking branch 'upstream/master'
b832f66
Previous merge didnt handle 2 conflicts properly
0d3c9a1
Previous merge did not handle 1 more conflict properly :-(
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,13 +3,16 @@ | |
Installing Python on Mac OS X | ||
============================= | ||
|
||
.. note:: | ||
Check out our :ref:`guide for installing Python 3 on OS X<install3-osx>`. | ||
|
||
The latest version of Mac OS X, El Capitan, **comes with Python 2.7 out of the box**. | ||
|
||
You do not need to install or configure anything else to use Python. Having | ||
said that, I would strongly recommend that you install the tools and libraries | ||
described in the next section before you start building Python applications | ||
for real-world use. In particular, you should always install Setuptools, as it | ||
makes it much easier for you to use other third-party Python libraries. | ||
You do not need to install or configure anything else to use Python. Having said | ||
that, I would strongly recommend that you install the tools and libraries | ||
described in the next section before you start building Python applications for | ||
real-world use. In particular, you should always install Setuptools, as it makes | ||
it much easier for you to install and manage other third-party Python libraries. | ||
|
||
The version of Python that ships with OS X is great for learning but it's not | ||
good for development. The version shipped with OS X may be out of date from the | ||
|
@@ -30,9 +33,14 @@ minimal but unofficial | |
package. | ||
|
||
.. note:: | ||
If you already have Xcode installed or plan to use Homebrew, do not install | ||
OSX-GCC-Installer. In combination, the software can cause issues that are | ||
difficult to diagnose. | ||
If you already have XCode installed, do not install OSX-GCC-Installer. | ||
In combination, the software can cause issues that are difficult to | ||
diagnose. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. please restore 'decent' :) |
||
|
||
.. note:: | ||
If you perform a fresh install of XCode, you will also need to add the | ||
commandline tools by running ``xcode-select --install`` on the terminal. | ||
|
||
|
||
While OS X comes with a large number of UNIX utilities, those familiar with | ||
Linux systems will notice one key component missing: a decent package manager. | ||
|
@@ -70,7 +78,7 @@ or Python 3: | |
This will take a minute or two. | ||
|
||
|
||
Setuptools & Pip | ||
Setuptools and Pip | ||
---------------- | ||
|
||
Homebrew installs Setuptools and ``pip`` for you. | ||
|
@@ -81,23 +89,23 @@ software over a network (usually the Internet) with a single command | |
capability to your own Python software with very little work. | ||
|
||
``pip`` is a tool for easily installing and managing Python packages, | ||
that is recommended over ``easy_install``. It is superior to ``easy_install`` in `several ways <https://python-packaging-user-guide.readthedocs.io/pip_easy_install/#pip-vs-easy-install>`_, | ||
that is recommended over ``easy_install``. It is superior to ``easy_install`` | ||
in `several ways <https://python-packaging-user-guide.readthedocs.io/pip_easy_install/#pip-vs-easy-install>`_, | ||
and is actively maintained. | ||
|
||
|
||
Virtual Environments | ||
-------------------- | ||
|
||
A Virtual Environment is a tool to keep the dependencies required by different projects | ||
in separate places, by creating virtual Python environments for them. It solves the | ||
"Project X depends on version 1.x but, Project Y needs 4.x" dilemma, and keeps | ||
A Virtual Environment (commonly referred to as a 'virtualenv') is a tool to keep the dependencies required by different projects | ||
in separate places, by creating virtual Python environments for them. It solves the | ||
"Project X depends on version 1.x but, Project Y needs 4.x" dilemma, and keeps | ||
your global site-packages directory clean and manageable. | ||
|
||
For example, you can work on a project which requires Django 1.10 while also | ||
maintaining a project which requires Django 1.8. | ||
|
||
To start using this and see more information: :ref:`Virtual Environments <virtualenvironments-ref>` docs. | ||
|
||
To start using this and see more information: :ref:`Virtual Environments <virtualenvironments-ref>` docs. | ||
|
||
-------------------------------- | ||
|
||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
.. _install3-osx: | ||
|
||
Installing Python 3 on Mac OS X | ||
================================ | ||
|
||
The latest version of Mac OS X, El Capitan, **comes with Python 2.7 out of the box**. | ||
|
||
You do not need to install or configure anything else to use Python 2. These | ||
instructions document the installation of Python 3. | ||
|
||
The version of Python that ships with OS X is great for learning but it's not | ||
good for development. The version shipped with OS X may be out of date from the | ||
`official current Python release <https://www.python.org/downloads/mac-osx/>`_, | ||
which is considered the stable production version. | ||
|
||
Doing it Right | ||
-------------- | ||
|
||
Let's install a real version of Python. | ||
|
||
Before installing Python, you'll need to install GCC. GCC can be obtained | ||
by downloading `XCode <http://developer.apple.com/xcode/>`_, the smaller | ||
`Command Line Tools <https://developer.apple.com/downloads/>`_ (must have an | ||
Apple account) or the even smaller `OSX-GCC-Installer <https://github.com/kennethreitz/osx-gcc-installer#readme>`_ | ||
package. | ||
|
||
.. note:: | ||
If you already have XCode installed, do not install OSX-GCC-Installer. | ||
In combination, the software can cause issues that are difficult to | ||
diagnose. | ||
|
||
.. note:: | ||
If you perform a fresh install of XCode, you will also need to add the | ||
commandline tools by running ``xcode-select --install`` on the terminal. | ||
|
||
While OS X comes with a large number of UNIX utilities, those familiar with | ||
Linux systems will notice one key component missing: a package manager. | ||
`Homebrew <http://brew.sh>`_ fills this void. | ||
|
||
To `install Homebrew <http://brew.sh/#install>`_, open :file:`Terminal` or | ||
your favorite OSX terminal emulator and run | ||
|
||
.. code-block:: console | ||
|
||
$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" | ||
|
||
The script will explain what changes it will make and prompt you before the | ||
installation begins. | ||
Once you've installed Homebrew, insert the Homebrew directory at the top | ||
of your :envvar:`PATH` environment variable. You can do this by adding the following | ||
line at the bottom of your :file:`~/.profile` file | ||
|
||
.. code-block:: console | ||
|
||
export PATH=/usr/local/bin:/usr/local/sbin:$PATH | ||
|
||
Now, we can install Python 3: | ||
|
||
.. code-block:: console | ||
|
||
$ brew install python3 | ||
|
||
This will take a minute or two. | ||
|
||
|
||
Pip | ||
---------------- | ||
|
||
Homebrew installs ``pip3`` for you. | ||
|
||
``pip3`` is the alias for the Python 3 version of ``pip`` on systems with both | ||
the Homebrew'd Python 2 and 3 installed. | ||
|
||
Working with Python3 | ||
-------------------- | ||
|
||
At this point, you have the system Python 2.7 available, potentially the | ||
:ref:`Homebrew version of Python 2 <install-osx>` installed, and the Homebrew | ||
version of Python 3 as well. | ||
|
||
.. code-block:: console | ||
|
||
$ python | ||
|
||
will launch the Python 2 interpreter. | ||
|
||
.. code-block:: console | ||
|
||
$ python3 | ||
|
||
will launch the Python 3 interpreter | ||
|
||
``pip3`` and ``pip`` will both be available. If the Homebrew version of Python | ||
2 is not installed, they will be the same. If the Homebrew version of Python 2 | ||
is installed then ``pip`` will point to Python 2 and ``pip3`` will point to | ||
Python 3. | ||
|
||
|
||
Virtual Environments | ||
-------------------- | ||
|
||
A Virtual Environment (commonly referred to as a 'virtualenv') is a tool to keep | ||
the dependencies required by different projects in separate places, by creating | ||
virtual Python environments for them. It solves the "Project X depends on | ||
version 1.x but, Project Y needs 4.x" dilemma, and keeps your global | ||
site-packages directory clean and manageable. | ||
|
||
For example, you can work on a project which requires Django 1.10 while also | ||
maintaining a project which requires Django 1.8. | ||
|
||
To start using this and see more information: :ref:`Virtual Environments <virtualenvironments-ref>` docs. | ||
|
||
-------------------------------- | ||
|
||
This page is a remixed version of `another guide <http://www.stuartellis.eu/articles/python-development-windows/>`_, | ||
which is available under the same license. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also don't think removing setuptools here is a good idea. It's important to know about these tools, even if you aren't going to use them directly.