babtools_EXAMPLE 0.9

Example structure with efficient PyPI usage: very small overhead for updating the PyPI entry.

This example covers a nice setup.py file, which gets name and description for the PyPI from the docstrings in itself as well as in the main file (babtools_EXAMPLE.py).

The changelog is automatically extracted from the file Changelog.txt and appended to the long description for the PyPI.

To customize it, you need to change the following:

• The first line of this files docstring - it will be your name and description in PyPI. You must keep the dash (” - “) as seperator between name and description to make getting name and description work.

• Every occurrence of “babtools_EXAMPLE” in this file to the name of your module

• Author, author_email, etc. in setup() to your preferred settings.

  • A list of all classifiers can be found via python setup.py register –list-classifiers

• This docstring to a mainly static description of your program.Things which may change at times should go into your main file (here it’s babtools_EXAMPLE.py).

• Your main files docstring, which provides the second paragraph (its first line is ignored).

For updating your PyPI entry to a new version, you only need to change the __version__ parameter in your main file (here it is babtools_EXAMPLE.py) and then run “python setup.py register” (no file release) or “python setup.py register sdist upload” to include a file release (sources).

Usage:

• babscript.py

  for default usage, or

• babscript.py –help

  for getting help

Examples:

• babscript.py

  Print the help message, since we have nothing else to do right now.

Plans:

• None. At the moment I’m happy with this structure.

Ideas:

• Adding information, how to use Mercurial to use this structure in your own project and keep it up to date while keeping your changes.

Source URL (Mercurial): U{http://freehg.org/u/ArneBab/babtools_EXAMPLE/}

PyPI URL: U{http://pypi.python.org/pypi/babtools_EXAMPLE}

Changelog:

babtools_EXAMPLe 0.9

• Added plans and ideas to the main file.

babtools_EXAMPLE 0.8

• Added customization instructions.

babtools_EXAMPLE 0.7

• Removed the title in the batools_EXAMPLE file from the PyPI description.”

babtools_EXAMPLE 0.6

• Improved code comments.

babtools_EXAMPLE 0.5

• Some cleaning up.

babtools_EXAMPLE 0.4

• Improved description on PyPI.

babtools_EXAMPLE 0.3

• Better documentation.

• Removed the name from the description for PyPI.

babtools_EXAMPLE 0.2

• Now reading changes from Changelog.txt

babtools_EXAMPLE 0.1

• Created working example structure.