NAME: {{package}}

AUTHOR:

DESCRIPTION:

Describe your application here.

{{project}} is built on the Cement CLI Application Framework.


USAGE:

    $ {{package}} --help
    
    
CONFIGURATION:

Application configuration files are parsed in the following order:

    * /etc/{{package}}/{{package}}.conf
    * ~/.{{package}}.conf


TESTING:

Tests require 'nose', and 'coverage' to be installed, and are run via the 
following command:

    $ python setup.py nosetests
    

HTML coverage reports can be generated via the command (after running tests):

    $ coverage html
    
    
BUILDING DOCUMENTATION:

The documentation is built as HTML, and located in ./doc/build via the 
following command:

    $ python setup.py build_sphinx
    
    
PLUGIN DEVELOPMENT:

{{project}} supports external plugins via the Cement Framework.  To quick
start a new plugin for {{project}} you can use the paster utility.

Setup a virtual environment for development:
    
    $ virtualenv --no-site-package /path/to/env
    
    $ source /path/to/env/bin/activate
    
    
Install {{project}}:
    
    $ cd /path/to/{{project}}
    
    $ python setup.py develop
    

Create and install the plugin:

    $ mkdir plugins
    
    $ cd plugins
    
    $ paster cement-plugin {{package}} myplugin
    
    $ cd {{package}}.myplugin
    
    $ python setup.py develop
    
    
Once your plugin is installed, you can enable it by adding a [plugin] block
to a plugin config in /etc/{{package}}/plugins.d/myplugin.conf. You should 
then see some example commands/options show up with:

    $ {{package}} --help
    
    
Then, code away!
