Skip to content

Replace all references to Distribute with Setuptools. #390

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.

Sign up for GitHub

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
kennethreitz merged 1 commit into from
Mar 31, 2014
Merged

Replace all references to Distribute with Setuptools. #390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/shipping/freezing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Windows
bbFreeze
~~~~~~~~

Prerequisite is to install :ref:`Python, Distribute and pywin32 dependency on Windows <install-windows>`.
Prerequisite is to install :ref:`Python, Setuptools and pywin32 dependency on Windows <install-windows>`.
Copy link
Contributor

@sigmavirus24 sigmavirus24 Mar 26, 2014

Choose a reason for hiding this comment

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

I'm not convinced that this change or the similar one in the diff below is accurate. These seem to be explicitly talking about pre-requisites for using the tools bbFreeze and PyInstaller. I will have to check if these actually can use setuptools or whether the references have to be to distribute. For what it is worth, there was effort made to make setuptools and the last version of distribute interchangable but for many users (and projectes) they are not. There are also several issues with one or two of the most recent versions of setuptools and prior versions.


.. todo:: Write steps for most basic .exe

Expand Down Expand Up @@ -79,7 +79,7 @@ Prerequisite is to install :ref:`Python on Windows <install-windows>`.
PyInstaller
~~~~~~~~~~~

Prerequisite is to have installed :ref:`Python, Distribute and pywin32 dependency on Windows <install-windows>`.
Prerequisite is to have installed :ref:`Python, Setuptools and pywin32 dependency on Windows <install-windows>`.

- `Most basic tutorial <http://bojan-komazec.blogspot.com/2011/08/how-to-create-windows-executable-from.html>`_
- `Manual <http://www.pyinstaller.org/export/d3398dd79b68901ae1edd761f3fe0f4ff19cfb1a/project/doc/Manual.html?format=raw>`_
Expand Down
16 changes: 8 additions & 8 deletions docs/starting/install/linux.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,21 @@ side-by-side with the system's Python 2.4 installation.
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 Distribute, as
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.

Distribute & Pip
Setuptools & Pip
----------------

The most crucial third-party Python software of all is Distribute, which
The most crucial third-party Python software of all is Setuptools, which
extends the packaging and installation facilities provided by the distutils
in the standard library. Once you add Distribute to your Python system you can
in the standard library. Once you add Setuptools to your Python system you can
download and install any compliant Python software product with a single
command. It also enables you to add this network installation capability to
your own Python software with very little work.

To obtain the latest version of Distribute for Linux, run the python script
available here: `python-distribute <http://python-distribute.org/distribute_setup.py>`_
To obtain the latest version of Setuptools for Linux, refer to the documentation
available here: `unix-setuptools <https://pypi.python.org/pypi/setuptools#unix-wget>`_

The new``easy_install`` command you have available is considered by many to be
deprecated, so we will install its replacement: **pip**. Pip allows for
Expand All @@ -48,7 +48,7 @@ To install pip, simply open a command prompt and run
Virtualenv
----------

After Distribute & Pip, the next development tool that you should install is
After Setuptools & Pip, the next development tool that you should install is
`virtualenv <http://pypi.python.org/pypi/virtualenv/>`_. Use pip

.. code-block:: console
Expand All @@ -68,7 +68,7 @@ project's directory

.. code-block:: console

$ virtualenv --distribute venv
$ virtualenv venv

To use an environment, run ``source venv/bin/activate``. Your command prompt
will change to show the active environment. Once you have finished working in
Expand Down
17 changes: 9 additions & 8 deletions docs/starting/install/osx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The latest version of Mac OS X, Mavericks, **comes with Python 2.7 out of the bo
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 Distribute, as it
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.

The version of Python that ships with OS X is great for learning, but it's not
Expand Down Expand Up @@ -64,25 +64,26 @@ new Python scripts directory to your ``PATH``
export PATH=/usr/local/share/python:$PATH


Distribute & Pip
Setuptools & Pip
----------------

The most crucial third-party Python software of all is Distribute, which
The most crucial third-party Python software of all is Setuptools, which
extends the packaging and installation facilities provided by the distutils
in the standard library. Once you add Distribute to your Python system you can
in the standard library. Once you add Setuptools to your Python system you can
download and install any compliant Python software product with a single
command. It also enables you to add this network installation capability to
your own Python software with very little work. Homebrew already installed
Distribute for you.
Setuptools for you.

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


Virtualenv
----------

After Distribute & Pip, the next development tool that you should install is
After Setuptools & Pip, the next development tool that you should install is
`virtualenv <http://pypi.python.org/pypi/virtualenv/>`_. Use pip

.. code-block:: console
Expand All @@ -102,7 +103,7 @@ the new environment.

.. code-block:: console

$ virtualenv --distribute venv
$ virtualenv venv

To use an environment, run ``source venv/bin/activate``. Your command prompt
will change to show the active environment. Once you have finished working in
Expand Down
2 changes: 1 addition & 1 deletion docs/starting/install/win.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ To install pip, run the python script available here:
Virtualenv
----------

After Distribute & Pip, the next development tool that you should install is
After Setuptools & Pip, the next development tool that you should install is
`virtualenv <http://pypi.python.org/pypi/virtualenv/>`_. Use pip

.. code-block:: console
Expand Down
4 changes: 2 additions & 2 deletions docs/starting/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ If so, 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 guides below before you start building Python
applications for real-world use. In particular, you should always install
Distribute, Pip, and Virtualenv — they make it much easier for you to use
Setuptools, Pip, and Virtualenv — they make it much easier for you to use
other third-party Python libraries.

Installation Guides
-------------------

These guides go over the proper installation of :ref:`Python 2.7 <which-python>`
for development purposes, as well as distribute, pip, and virtualenv setup.
for development purposes, as well as setuptools, pip, and virtualenv setup.

- :ref:`Mac OS X <install-osx>`.
- :ref:`Microsoft Windows<install-windows>`.
Expand Down