Templates for mr.bob
Project description
Python package templates for mr.bob. Please read carefully mr.bob documentation before using this package.
Installation
pip install bobtemplates.gillux
About the templates
bobtempaltes.gillux offers the following templates :
buildout
A simple minimal zc.buildout based project bootstrap
mybobtemplate
Make your own bobtemplate.yourname package in a few minutes (or more).
nspackage
A regular Python package with or without namespace, any level with lots of goodies.
buildout
Usage
> mrbob [options] bobtemplates.gillux:buildout
This provides a minimal zc.buildout based project, with a bootstrap.py file and a buildout.cfg file. Takes care of differences between versions 1.x and 2.x of zc.buildout.
mybobtemplate
Usage
> mrbob [options] bobtemplates.gillux:mybobtemplate
Make your own bobtemplate.yourname package in a few minutes (or more). Means that you can have the skeleton of a package like bobtemplates.gillux in some seconds.
You just need to add the content of your template as described in the mr.bob documentation
nspackage
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
Tests with nose and nosexcover. Run them with nosetests. Tune your options in generated setup.cfg.
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:
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.
TODO
Provide a six support option
Make nosetests support optional
Make Sphinx support optional (overkill for small packages, remove the docs/ subtree)
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.
Links
- Project workspace @ Github (contribute, file issues…):
- Project page @ Pypi:
- mr.bob @ Pypi:
- mr.bob @ Readthedocs:
Changes log
1.0.0
Added the “mybobtemplate” template for new bobtemplates.xxx packages skeletons. [glenfant]
Added .xxignore files for git, bazaar and mercurial to the “buildout” template. [glenfant]
setuptools/distribute don’t let us distribute empty directories. So we need to put a marker file in some directories then remove them. [glenfant]
1.0.0b1
Python 3 support (alpha). Please feeback [glenfant]
Added the “buildout” template, a minimal zc.buildout project bootstrap [glenfant]
Added .xxignore files for git, bazaar and mercurial [glenfant]
Gone through the weirdness of include_package_data, package_data and MANIFEST.in This setuptools / distribute feature really sucks [glenfant]
1.0.0a2
Improved README about namespaces support. [glenfant]
Renamed mrbobtemplates.gillux -> bobtemplates.gillux as in standard policy http://mrbob.readthedocs.org/en/latest/userguide.html#collection-of-community-managed-templates [glenfant]
1.0.0a1
First public version [glenfant]
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 bobtemplates.gillux-1.0.0.tar.gz
.
File metadata
- Download URL: bobtemplates.gillux-1.0.0.tar.gz
- Upload date:
- Size: 16.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d733b7365335018a3915f250a26781f59d89ff7c0d5a34e84149cdc46a1a5a38 |
|
MD5 | 9c3a1bd7194f4d0c2427bb4954728b21 |
|
BLAKE2b-256 | 376b869a1d87bd64563740e4616886512091cc56682d253907e328cf92cdb2d9 |