PasteScript template to create a Python project with distribute and buildout support
Project description
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:
Use Distribute instead of setuptools as the BDFL himself supports it.
Buildout support, though you are not required to make use of it.
README.txt and NEWS.txt automatically included in your package metadata as long_description, thus making them appear in the PyPI page for your project.
Automatic script (or .exe) creation using Distribute
Here is a sample project created using modern-package-template.
See the section titled “Roadmap” below for planned features.
Getting started
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.txt and edit it accordingly.
Roadmap
In the next release, I’d like to add support for Sphinx and Sphinx-PyPI-upload tool, so that developers can upload their sphinx-based documentation to packages.python.org without having to manually do it themselves.
If you like, please help with working on one of the new/open issues.
Credits
Source code is derived from the advanced_package template - which is also licensed under GPLv3.
News
1.0c2
Release date: 02-Apr-2010
#18: Fix missing .hgignore
1.0c1
Release date: 30-Mar-2010
Add a ‘Credits’ section to README.txt
#2: Include a sample entry point
#13: Include .hgignore
#11: Include dev howtos in HACKING.txt
Remove setup.cfg – simple to have no .dev marker
1.0b2
Release date: 15-Mar-2010
#10: Remove dependency on Distribute
#9: Remove distribute_setup.py
1.0b1
Release date: 14-Mar-2010
#6: Remove zip_safe from the template questionnaire
#3: Add README.txt and NEWS.txt as a replacement for long_description
#1: Add distribute_setup.py to the template
0.9.2
Release date: 14-Feb-2010
Provide a complete buildout.cfg that is usable
Use buildout by default
Use Distribute instead of Setuptools
Inherit from harobed.paster_template.advanced_package 0.2
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file modern-package-template-1.0c2.tar.gz
.
File metadata
- Download URL: modern-package-template-1.0c2.tar.gz
- Upload date:
- Size: 7.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | dddf7d45bd200a3cb8fc452b5a6f2836ad52678e24c2b6c7e18cb2541afe13f0 |
|
MD5 | 847ef1de8ea6aa3cd6b172fa5c3e7582 |
|
BLAKE2b-256 | a4fd5c85c95ce4e7f7d190010186705b45e82743c0a8a100ab4d2240f55969ad |