Metadata-Version: 1.0
Name: bobtemplates.gillux
Version: 1.0.0b1
Summary: Templates for mr.bob
Home-page: http://pypi.python.org/
Author: Gilles Lenfant
Author-email: gilles.lenfant@gmail.com
License: GPLv3
Description: ===================
        bobtemplates.gillux
        ===================
        
        Python package templates for `mr.bob <http://pypi.python.org/pypi/mr.bob/>`_.
        Please read carefully `mr.bob documentation
        <http://mrbob.readthedocs.org/en/latest/index.html>`_ before using this
        package.
        
        Installation
        ============
        
        ::
        
          pip install bobtemplates.gillux
        
        .. admonition::
           Note
        
           This will install `mr.bob`_ and its requirements too if not already done.
        
        About the templates
        ===================
        
        ``bobtempaltes.gillux`` offers the following templates :
        
        buildout
        
          A simple minimal zc.buildout based project bootstrap
        
        nspackage
        
          A regular Python package with or without namespace, any level
        
        buildout
        --------
        
        Usage ::
        
          > mrbob [options] bobtemplates.gillux:buildout
          > mrbob [options] 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.
        
        nspackage
        ---------
        
        Usage ::
        
          > mrbob [options] bobtemplates.gillux:nspackage
          > mrbob [options] 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 <https://nose.readthedocs.org/en/latest/index.html>`_ and
          `nosexcover <http://pypi.python.org/pypi/nosexcover/>`_. Run them with
          ``python setup.py nosetests``
        
        - A `Sphinx <http://sphinx-doc.org/>`_ 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 <http://pypi.python.org/pypi/six/>`_ support option
        - Make nosetests and sphinx supports optional
        
        Links
        =====
        
        Project workspace @ Github (contribute, file issues...):
            https://github.com/glenfant/bobtemplates.gillux
        Project page @ Pypi:
            http://pypi.python.org/pypi/bobtemplates.gillux
        mr.bob @ Pypi:
            http://pypi.python.org/pypi/mr.bob/
        mr.bob @ Readthedocs:
          http://mrbob.readthedocs.org/en/latest/
        
        Changes log
        ===========
        
        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]
Keywords: mr.bob template
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
