Editing Packaging Stand-Alone Django Apps

[[category:Django]] [[Category:Python]] [[Category:Web Development]]
== Directory structure ==

The app goes in a directory outside of any Django web project. If the app is `addresses`, structure it `littled-addresses/addresses/`.<ref>[https://docs.djangoproject.com/en/1.7/intro/reusable-apps How to Write Reusable Apps] (Django documentation)</ref>

Try to avoid naming conflicts, of course. (Check resources like PyPI.)

* Create `README.rst`
** In the package root, e.g. `littled-addresses/README.rst`.
** Sample contents at [https://docs.djangoproject.com/en/1.7/intro/reusable-apps/#packaging-your-app How to Write Reusable Apps&mdash;Packaging your app]
* Create `LICENSE` file in the package root. 
** Django itself uses the BSD license.
* Create `setup.py` in the project root.
** Sample at [https://docs.djangoproject.com/en/1.7/intro/reusable-apps/#packaging-your-app How to Write Reusable Apps&mdash;Packaging your app]
** More complete documentation at [http://pythonhosted.org/setuptools/setuptools.html setuptools docs].
* Create `MANIFEST.in` in the project root.
** This includes files other than Python modules and packages.
* Create a `docs` directory
** Include it in `MANIFEST.in` with `recursive-include docs *`

== Building the package ==

<syntaxhighlight lang="bash">
$ python setup.py sdist
</syntaxhighlight>

* Run from the package root directory.
* Creates a `dist` directory which contains the (zipped) package.

== Using the package ==

<syntaxhighlight lang="bash">
$ pip install --user django-addresses/dist/django-addresses-0.1.tar.gz
</syntaxhighlight>

This installs the package on a system as a ''user'' library.

It can now be referenced in other Django projects.

== Uninstalling the package ==

<syntaxhighlight lang="bash">
$ pip uninstall django-addresses
</syntaxhighlight>

== Notes ==
<references />