Package: bobtemplates.gillux
bobtemplates.gilluxwill save your valuable time on a few hours of
repetitive and tiresome task when you create a new Python package in the form
of some templates formr.bob.Please read carefullymr.bob user documentationif you need to customizebobtemplates.gilluxbeyond what’s written hereafter.If you lovebobtemplates.gillux, you maystart it on Github.Installationpip install bobtemplates.gilluxAbout the templatesbobtempaltes.gilluxoffers the following templates :nspackageA regular Python package bootstrap with or without namespace, any level with
lots of goodies.buildoutA simple minimal zc.buildout based project bootstrapmybobtemplateMake your ownbobtemplate.yournamebootstrap in a some seconds (or more).nspackageUsagemrbob [options] bobtemplates.gillux:nspackageA 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.xTwo optional features:Tests withnoseandcoverage. Run them withnosetests. Tune your options in generatedsetup.cfg. By default, tests
will be “dicovered” automatically (Python 2.7 or 3.3unittest), or withunittest2for other Python versions.ASphinxdocumentation skeleton. Build the HTML
doc withpython 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.inThen grep - and optionally fix - theFIXME:that occur in the resulting
files tree for optional stuffs I couldn’t fix easily with the regular mr.bob
features.Read the generatedREADME.rstin your newly created package for more
information about what you got.nspackage wizard questionsYour 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. Aspip 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 insetup.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.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 withpython setup.py developor installing your released package withpip install .... The command will execute theyourpackage.__main__.mainfunction, with pre-cookedargparseandloggingcookies.Use nose tests [true|false]?If you’re a nosetests fan, otherwise the tests layout will use the now
classical tests auto discovery feature ofunittestorunittest2for
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 thedocsdirectory. You just need to
typepython 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
answeredfalseto 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.gitignoreor whatever’s SCM suited exclude files.TODOProvide asixsupport optionTests 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.buildoutUsage:mrbob [options] bobtemplates.gillux:buildoutThis provides a minimal zc.buildout based project, with abootstrap.pyfile and a buildout.cfg file. Takes care of differences between versions 1.x
and 2.x of zc.buildout.mybobtemplateUsage:mrbob [options] bobtemplates.gillux:mybobtemplateMake your ownbobtemplate.yournamepackage skeleton in a few minutes.
Means that you can have the skeleton of a package likebobtemplates.gilluxin some seconds.You just need to add the content of your template as described in themr.bob
user documentationLinksProject workspace @ Github (contribute, file issues…):https://github.com/glenfant/bobtemplates.gilluxProject page @ Pypi:http://pypi.python.org/pypi/bobtemplates.gilluxmr.bob @ Pypi:http://pypi.python.org/pypi/mr.bob/mr.bob @ Readthedocs:http://mrbob.readthedocs.org/en/latest/Changes log1.3.0 (2015-06-28)doc: removed warning about pip bug that’s now gone.
[glenfant]nspackage: Added an option for a console command
[glenfant]nspackage: Replaced package name by distro name when relevant.nspackage: Renamed “docs/” to more usual “doc/”
[glenfant]1.2.0 (2015-04-07)nspackage: Added a “run_tests.py” testrunner command
[glenfant]nspackage: A comprehensive doc in README.rst.
[glenfant]nspackage: Sphinx skeleton built from 1.3.1 default
[glenfant]nspackage: PEP 440 compatible initial version.
[glenfant]nspackage: Sphinx autodoc demo in API chapter.
[glenfant]all: Use new “code” reStructuredText directive.
[glenfant]1.1.0 (2014-06-18)nspackage: Distro name and package (Python) name can be distinct.
[glenfant]nspackage: Use of nosetests + coverage is optional
[glenfant]nspackage: Sphinx doc skeleton is optional
[glenfant]1.0.0 (2014-01-03)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 (2013-02-17)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 (2013-02-10)Improved README about namespaces support.
[glenfant]Renamed mrbobtemplates.gillux -> bobtemplates.gillux as in standard policyhttp://mrbob.readthedocs.org/en/latest/userguide.html#collection-of-community-managed-templates[glenfant]1.0.0a1 (2013-02-10)First public version
[glenfant]