bobtemplates.gillux will save a few hours of your valuable time,
taking care of repetitive and tiresome tasks when you create a new Python
package, by way of some templates for
Please read the mr.bob user documentation if you need to customize
bobtemplates.gillux beyond what's written here.
If you love
bobtemplates.gillux, you may star it on Github.
pip install bobtemplates.gillux
About the templates
bobtempaltes.gillux offers the following templates :
A regular Python package bootstrap with or without namespace, any level with lots of goodies.
A simple minimal zc.buildout based project bootstrap
Make your own bobtemplate.yourname bootstrap in a few seconds (or more).
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
unittest2for other Python versions.
- A Sphinx documentation skeleton. Build the HTML
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 doc/ # 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: markers that occur in the
resulting file tree for optional things 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.
The name of the distro that will be used to install with pip, as in
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 by which your package is known to Python, as in
import foo.bar.baz. Namespace packages are automatically detected for the structure of the package directory tree and the registration in
What will be in this distro's PyPI page subtitle and in the packages listing.
The team or company that owns the package copyright.
Shell command (leave empty if you don't need it)?
Installing this package will add this command to your system or activated virtualenv.
This command will be available after you install your new package with
python setup.py developor installing your released package with
pip install .... The command will execute the
yourpackage.__main__.mainfunction, with pre-cooked
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
unittest2for 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
docsdirectory. You just need to type
python setup.py build_sphinxto 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 file suits the selected SCM).
- 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.
- Remove annoying xxx.pyc files I dunno why they are created by mrbob (?)
mrbob [options] bobtemplates.gillux:buildout
This provides a minimal
zc.buildout based project, with a
file and a
buildout.cfg file. Takes care of differences between versions
1.x and 2.x of
mrbob [options] bobtemplates.gillux:mybobtemplate
Make your own bobtemplate.yourname package skeleton in a few minutes.
This means that you can have the skeleton of a package like
bobtemplates.gillux in just a few seconds.
You just need to add the content of your template as described in the mr.bob user documentation