modern-package-template

modern-package-template is a PasteScript template_ to create an initial layout for your Python projects using modern tools and practices followed in the Python community. Thus, your projects will have the following characteristics:

1. Use Distribute instead of setuptools as the BDFL himself supports it.
2. Buildout_ support, though you are not required to make use of it.
3. README.rst and NEWS.rst automatically included in your package metadata as long_description, thus making them appear in the PyPI page for your project (example <http://pypi.python.org/pypi/applib>).
4. Automatic script (or .exe) creation using Distribute's "entry points".

Here is a sample project_ created using modern-package-template.

.. _PyPI: http://pypi.python.org/ .. _Buildout: http://www.buildout.org/ .. _supports: http://mail.python.org/pipermail/python-dev/2009-October/092678.html .. Distribute: http://packages.python.org/distribute/ .. PasteScript template: http://pythonpaste.org/script/developer.html#templates .. _a sample project: http://github.com/srid/mpt-sample

Getting started

First install modern-package-template using PyPM or pip:

::

$ pypm install modern-package-template

OR

$ pip install modern-package-template

.. _PyPM: http://code.activestate.com/pypm/ .. _pip: http://pip.openplans.org/

To create a Python project called "helloworld", run the following command in your terminal:

::

$ paster create -t modern_package helloworld

You can also, optionally, create namespace packages_:

::

$ paster create -t modern_package my.new.package package=my.new.package

.. _namespace packages: http://packages.python.org/distribute/setuptools.html#namespace-packages

Once you create the project layout, the very first thing you must do is to review the contents of README.rst and edit it accordingly.

Credits

Source code is derived from the advanced_package_ template - which is also licensed under GPLv3.

.. _advanced_package: http://pypi.python.org/pypi/harobed.paster_template.advanced_package/