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:
- Use Distribute instead of setuptools as the BDFL himself supports it.
- Buildout support, though you are not required to make use of it.
README.rst
andNEWS.rst
automatically included in your package metadata aslong_description
, thus making them appear in the PyPI page for your project (example).- Automatic script (or .exe) creation using Distribute's "entry points".
Here is a sample project created using modern-package-template.
First install modern-package-template using PyPM or pip:
$ pypm install modern-package-template OR $ pip install modern-package-template
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
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.
Source code is derived from the advanced_package template - which is also licensed under GPLv3.