Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/srid/modern-package-template
[unmaintained] Modern project template for Python [2010]
https://github.com/srid/modern-package-template
python
Last synced: about 2 months ago
JSON representation
[unmaintained] Modern project template for Python [2010]
- Host: GitHub
- URL: https://github.com/srid/modern-package-template
- Owner: srid
- Created: 2010-07-11T05:13:14.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2010-12-07T06:56:37.000Z (about 14 years ago)
- Last Synced: 2024-04-25T10:22:13.239Z (8 months ago)
- Topics: python
- Language: Python
- Homepage:
- Size: 571 KB
- Stars: 51
- Watchers: 4
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
- starred-awesome - modern-package-template - [unmaintained] Modern project template for Python [2010] (Python)
README
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 `_).
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-sampleGetting 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/