Ticket #16671: tutorial05.5.diff

AUTHORS

@@ -357 +357 @@
     Christian Metts
     michal@plovarna.cz
     Slawek Mikula <slawek dot mikula at gmail dot com>
+    Katie Miller <katie@sub50.com>
     Shawn Milochik <shawn@milochik.com>
     mitakummaa@gmail.com
     mmarshall
@@ -474 +475 @@
     Johan C. Stöver <johan@nilling.nl>
     Nowell Strite <http://nowell.strite.org/>
     Thomas Stromberg <tstromberg@google.com>
+    Ben Sturmfels <ben@stumbles.id.au>
     Pascal Varet
     SuperJared
     Radek Švarz <http://www.svarz.cz/translate/>

docs/index.txt

@@ -42 +42 @@
       :doc:`Part 1 <intro/tutorial01>` |
       :doc:`Part 2 <intro/tutorial02>` |
       :doc:`Part 3 <intro/tutorial03>` |
-      :doc:`Part 4 <intro/tutorial04>`
+      :doc:`Part 4 <intro/tutorial04>` |
+      :doc:`Part 5 <intro/tutorial05>`
 
 The model layer
 ===============

docs/intro/index.txt

@@ -13 +13 @@
    tutorial02
    tutorial03
    tutorial04
+   tutorial05
    whatsnext
    
 .. seealso::
@@ -33 +34 @@
     .. _list of Python resources for non-programmers: http://wiki.python.org/moin/BeginnersGuide/NonProgrammers
     .. _dive into python: http://diveintopython.org/
     .. _dead-tree version: http://www.amazon.com/exec/obidos/ASIN/1590593561/ref=nosim/jacobian20
-    .. _books about Python: http://wiki.python.org/moin/PythonBooks
- No newline at end of file
+    .. _books about Python: http://wiki.python.org/moin/PythonBooks

docs/intro/tutorial04.txt

@@ -322 +322 @@
 For full details on generic views, see the :doc:`generic views documentation
 </topics/http/generic-views>`.
 
-Coming soon
-===========
-
-The tutorial ends here for the time being. Future installments of the tutorial
-will cover:
-
-    * Advanced form processing
-    * Using the RSS framework
-    * Using the cache framework
-    * Using the comments framework
-    * Advanced admin features: Permissions
-    * Advanced admin features: Custom JavaScript
-
-In the meantime, you might want to check out some pointers on :doc:`where to go
-from here </intro/whatsnext>`
+When you're comfortable, read :doc:`part 5 of this tutorial
+</intro/tutorial05>` to learn about turning Polls into a reusable app.

new file docs/intro/tutorial05.txt

@@ +1 @@
+=====================================
+Writing your first Django app, part 5
+=====================================
+
+This tutorial begins where :doc:`Tutorial 4 </intro/tutorial04>` left
+off. We'll be turning our Web-poll into a stand-alone Python package you can
+reuse and share.
+
+.. Outline:
+
+.. * motivation
+..     * what is a python package?
+..     * what is a django app?
+..     * what is a reusable app?
+
+.. * preparing
+..     * moving templates into your app
+..     * parent directory
+..     * adding package boilerplate
+..     * link to packaging docs
+..     * package builder
+
+.. * using the package
+..     * how to install
+
+.. * publishing
+..     * options for publishing
+..     * link to docs on PyPI
+
+Python packages and reusable apps
+==================================
+
+Django really is just Python. This means that you can make use of existing
+Python packages and Django apps in your project.
+
+The concept of piecing together projects out of *reusable apps* is one of
+Django's most powerful features. Doing so, you avoid solving the same problems
+over again. The only parts you need to write are those that make your project
+unique.
+
+.. note::
+
+    A Python `package <http://docs.python.org/tutorial/modules.html#packages>`_
+    is a way of grouping related Python code for easy reuse. A package contains
+    one or more files of Python code (also known as "modules").
+
+    A package can be imported with ``import foo.bah`` or ``from foo import
+    bar``. For a directory (like ``polls``) to be a package, it must contain a
+    special file ``__init__.py``, even if the file is empty.
+
+    A Django *app* is just a Python package that is specifically intended for
+    use in a Django project. An app may also use common Django conventions,
+    such as having a ``models.py`` file.
+
+    Later on we use the term *packaging* to describe the process of making a
+    Python package easy for others to install. It can be little confusing, we
+    know.
+
+Let's say you had written a Polls app and wanted to use it in a brand new
+project. How do you make it easily reusable? It just so happens that you're
+well on the way already.
+
+In the previous tutorials, we began making Polls reusable by decoupling it from
+the project-level URLconf. In this tutorial, we'll take further steps to make
+the app easily to use in new projects and ready to publish for others to
+install and use.
+
+Completing your reusable app
+============================
+
+The Polls app we've been working on is already a Python package (thanks to the
+``__init__.py`` inside ``polls``). That's a good start.
+
+We can't just pick up this package and drop it into a new project yet
+though. The Polls templates are currently stored in the project-wide
+``templates`` directory. To make the app self-contained, we need to store these
+templates within the ``polls`` directory.
+
+Inside ``mysite/polls``, create the directory ``templates`` and *inside* that,
+the directory ``polls``. Move the ``index.html`` and ``detail.html`` templates
+into ``templates/polls``. This allows the app's templates to be distributed
+with the app. Confirm that your poll Web site still works correctly.
+
+Your project should now look like this::
+
+    mysite/
+        polls/
+            admin.py
+            templates/
+                polls/
+                    detail.html
+                    index.html
+            __init__.py
+            models.py
+            tests.py
+            urls.py
+            views.py
+        __init__.py
+        manage.py
+        settings.py
+        urls.py
+
+.. NOTE:: Why create a ``polls`` directory under templates when we're already
+   inside the Polls app? This directory is needed to avoid conflicts because of
+   how Django's ``app_directories`` template loader works.
+
+You now have a package that could be copied into new Django projects and
+immediately reused. It's not yet ready to be published though. For that, we
+need to package the app to make it easy for others to install.
+
+Packaging your app
+==================
+
+Python packaging isn't as hard as it sounds, especially for such a small app.
+
+1. Firstly, create a parent directory for ``polls``, outside of your Django
+   project. Call this directory ``django-polls``.
+
+2. Move the ``polls`` directory into the ``django-polls`` directory.
+
+3. Create a file ``django-polls/README.txt`` with the following contents::
+
+       =====
+       Polls
+       =====
+
+       Polls is a simple Django app to conduct Web-based polls. For each
+       question, visitors can choose between a fixed number of answers.
+
+       Detailed documentation is in the "docs" directory.
+
+       Quick start
+       -----------
+
+       1. Add "polls" to your INSTALLED_APPS setting like this::
+
+              INSTALLED_APPS = (
+                  ...
+                  'polls',
+              )
+
+       2. Include the polls URLconf in your project urls.py like this::
+
+              (r'^polls/', include('polls.urls')),
+
+       3. Run `python manage.py syncdb` to create the polls models.
+
+       4. Start the development server and visit http://127.0.0.1:8000/admin/
+          to create a poll (you'll need the Admin app enabled).
+
+       5. Visit http://127.0.0.1:8000/polls/ to participate in the poll.
+
+
+5. Create a file ``django-polls/setup.py`` with the following contents::
+
+    from distutils.core import setup
+
+    setup(
+        name='django-polls',
+        version='0.1',
+        packages=['polls',],
+        license='',
+        long_description=open('README.txt').read(),
+        url='http://www.example.com/',
+        author='Your Name',
+        author_email='yourname@example.com',
+    )
+
+6. It's optional, but recommended, to include detailed documentation with
+   your app. Create an empty directory ``django-polls/docs`` for future
+   documentation. Create a file ``django-polls/MANIFEST.in`` with the following
+   contents::
+
+       recursive-include docs *
+
+   This instruction ensures that the ``docs`` directory is included in the
+   package.
+
+7. Try building your package with ``python setup.py sdist`` (run from inside
+   ``django-polls``. This creates a directory called ``dist`` and builds your
+   new package, ``django-polls-0.1.tar.gz``.
+
+For more information on packaging, see `The Hitchhiker's Guide to Packaging
+<http://guide.python-distribute.org/quickstart.html>`_.
+
+Using your own package
+======================
+
+Since we moved the ``polls`` directory out of the project, it's no longer
+working. We'll now fix this by installing our new ``django-polls`` package.
+
+.. NOTE:: The following steps install ``django-polls`` as a system library. In
+   general, it's best to avoid messing with your system libraries to avoid
+   breaking things. For this simple example though, the risk is low and it will
+   help with understanding packaging. We'll explain how to uninstall in
+   step 4.
+
+   For experienced users, a neater way to manage your packages is to use
+   "virtualenv" (see below).
+
+1. Inside ``django-polls/dist``, untar the new package
+   ``django-polls-0.1.tar.gz`` (e.g. ``tar xzvf django-polls-0.1.tar.gz``). If
+   you're using Windows, you can download the command-line tool bsdtar_ to do
+   this, or you can use a GUI-based tool such as 7-zip_.
+
+2. Change into the directory created in step 1 (e.g. ``cd django-polls``).
+
+3. If you're using GNU/Linux, Mac OS X or some other flavor of Unix, enter the
+   command ``sudo python setup.py install`` at the shell prompt.  If you're
+   using Windows, start up a command shell with administrator privileges and
+   run the command ``setup.py install``.
+
+   With luck, your Django project should now work correctly again. Run the
+   server again to confirm this.
+
+4. To uninstall the package, delete the directory ``polls`` and the file
+   ``django_polls-0.1.egg-info`` from your system libraries. On GNU/Linux and
+   Mac OS these files live in ``/usr/local/lib/python2.X/dist-packages``, and
+   on Windows, in ``C:\Python2X\Lib\site-packages`` (where *X* is the Python
+   minor version number). You will need administrator privileges.
+
+.. _bsdtar: http://gnuwin32.sourceforge.net/packages/bsdtar.htm
+.. _7-zip: http://www.7-zip.org/
+
+Publishing your app
+===================
+
+Now that we've packaged and tested ``django-polls``, it's ready to share with
+the world! If this wasn't just an example, you could now:
+
+    * Email the package to a friend.
+
+    * Upload the package on your Web site.
+
+    * Post the package on a public repository, such as `The Python Package
+      Index (PyPI)
+      <http://guide.python-distribute.org/contributing.html#pypi-info>`_.
+
+For more information on PyPI, see the `Quickstart
+<http://guide.python-distribute.org/quickstart.html#register-your-package-with-the-python-package-index-pypi>`_
+section of The Hitchhiker's Guide to Packaging. One detail this guide mentions
+is choosing the license under which your code is distributed.
+
+Installing Python packages with virtualenv
+==========================================
+
+Earlier, we installed the Polls app as a system library. This has some
+disadvantages:
+
+    * Modifying the system libraries can affect other Python software on your
+      system.
+
+    * You won't be able to run multiple version of this package (or others with
+      the same name).
+
+Typically, these situations only arise once you're maintaining several Django
+projects. When they do, the best solution is to use `virtualenv
+<http://www.virtualenv.org/>`_. This tool allows you to maintain multiple
+isolated Python environments, each with its own copy of the libraries and
+package namespace.
+
+Further information
+===================
+
+For more on writing reusable apps, see `What is a reusable app?
+<http://ericholscher.com/projects/django-conventions/app/>`_ by Eric
+Holsher. For a collection of reusable apps to use in your own projects, see the
+`Pinax <http://pinaxproject.com/>`_ project.
+
+The tutorial ends here for the time being. In the meantime, you might want to
+check out some pointers on :doc:`where to go from here </intro/whatsnext>`.