p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Recommended setuptools in the reuseable app tutorial. 

setuptools has merged with distribute.
This commit is contained in:
Dražen Lučanin 2013-11-15 20:06:32 +01:00 committed by Tim Graham
parent ebfa508fa3
commit b5eef8535a
1 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/intro/reusable-apps.txt
View File

@ -100,14 +100,14 @@ Installing some prerequisites
=============================
The current state of Python packaging is a bit muddled with various tools. For
this tutorial, we're going to use distribute_ to build our package. It's a
community-maintained fork of the older ``setuptools`` project. We'll also be
this tutorial, we're going to use setuptools_ to build our package. It's the
recommended packaging tool (merged with the ``distribute`` fork). We'll also be
using `pip`_ to install and uninstall it. You should install these
two packages now. If you need help, you can refer to :ref:`how to install
Django with pip<installing-official-release>`. You can install ``distribute``
Django with pip<installing-official-release>`. You can install ``setuptools``
the same way.
.. _distribute: http://pypi.python.org/pypi/distribute
.. _setuptools: https://pypi.python.org/pypi/setuptools
.. _pip: http://pypi.python.org/pypi/pip
Packaging your app
@ -174,8 +174,8 @@ this. For a small app like polls, this process isn't too difficult.
5. Next we'll create a ``setup.py`` file which provides details about how to
build and install the app. A full explanation of this file is beyond the
scope of this tutorial, but the `distribute docs
<http://packages.python.org/distribute/setuptools.html>`_ have a good
scope of this tutorial, but the `setuptools docs
<http://packages.python.org/setuptools/setuptools.html>`_ have a good
explanation. Create a file ``django-polls/setup.py`` with the following
contents:
@ -216,15 +216,9 @@ this. For a small app like polls, this process isn't too difficult.
],
)
.. admonition:: I thought you said we were going to use ``distribute``?
Distribute is a drop-in replacement for ``setuptools``. Even though we
appear to import from ``setuptools``, since we have ``distribute``
installed, it will override the import.
6. Only Python modules and packages are included in the package by default. To
include additional files, we'll need to create a ``MANIFEST.in`` file. The
distribute docs referred to in the previous step discuss this file in more
setuptools docs referred to in the previous step discuss this file in more
details. To include the templates, the ``README.rst`` and our ``LICENSE``
file, create a file ``django-polls/MANIFEST.in`` with the following
contents: