bobtemplates.gillux 1.2.0

Usage

mrbob [options] bobtemplates.gillux:nspackage

A regular Python package bootstrap with following features:

• Any namespaces level you want, even none at all. This is detected with the name you provide in the wizard.

• Code targeted to Python 2.4 to 2.7 and 3.x

Two optional features:

• Tests with nose and coverage. Run them with nosetests. Tune your options in generated setup.cfg. By default, tests will be “dicovered” automatically (Python 2.7 or 3.3 unittest), or with unittest2 for other Python versions.

• A Sphinx documentation skeleton. Build the HTML doc with python setup.py build_sphinx. The doctest files may optionally be automatically included in the doc.

Package files outline (may change depending on options):

src/<your>/<package>/  # Your package source skeleton
docs/                  # Sphinx source tree skeleton
tests/                 # Test module skeleton with nose goodies
setup.py               # Usual setup script
setup.cfg
README.rst
MANIFEST.in

Then grep - and optionally fix - the FIXME: that occur in the resulting files tree for optional stuffs I couldn’t fix easily with the regular mr.bob features.

Read the generated README.rst in your newly created package for more information about what you got.

nspackage wizard questions

Your full name?

Your full name (like “John Doe”)

Your short name?

Your short name (like “jdoe”). Usually your PyPI or Github login is a good idea.

Your mail address?

This mail address will not appear on the PyPI page of this distro.

Distribution name?

The name of the distro that will be used to install with pip. As pip install (this name). Make sure that it is not yet used by any of the 50000+ packages known by PyPI.

Package name - can be with namespaces (“foo.bar.baz”) or not (“foo”)?

The name your package is known by Python like in “import foo.bar.baz”. Namespace packages are automatically detected for the structure of the package directory tree and the registration in setup.py.

Package description?

What will be in this distro’s PyPI page subtitle and in the packages listing.

Organization?

The team ou company that owns the package copyright.

Use nose tests [true|false]?

If you’re a nosetests fan, otherwise the tests layout will use the now classical tests auto discovery feature of unittest or unittest2 for older versions of Python.

Add a Sphinx doc skeleton [true|false]?

Big Python projects should have a Sphinx doc. This option provides a Sphinx layout prepared for your project in the docs directory. You just need to type python setup.py build_sphinx to build the HTML doc.

Include doctest files in Sphinx doc [true|false]?

A copy of all your doctest files (tests/test_*.txt) will be included in the Sphinx documentation. Of course, this question does not appear if you answered false to the previous question.

What SCM do you plan to use [git|hg|bzr|none]?

We provide some cookies for Git, Mercurial and Bazaar in the form of a .gitignore or whatever’s SCM suited exclude files.

TODO

• Provide a six support option

• Tests inside the source tree (in src/<your>/<package>/tests) OR in the package root. Sometimes we prefer to ship source distros with the tests, and sometimes (i.e big amount of test data) we prefer to keep a source dist small.