Pip and Distribute

If you are on Linux or Mac OS X, just type:

$ sudo pip install projy

If no pip available, try easy_install:

$ sudo easy_install projy

Install from git

If you prefer git, that is ok too. You can get the very latest code at Github:

$ git clone http://github.com/stephanepechard/projy

A simple example

Use simply:

$ projy PythonPackage TowelStuff

In the same directory as you typed this command, you now have a TowelStuff directory, with the following structure:

TowelStuff/
    bin/
    bootstrap
    CHANGES.txt
    docs/
        index.rst
    LICENSE.txt
    MANIFEST.in
    README.txt
    setup.py
    towelstuff/
        __init__.py

Each file has been created with a specific template, so the package is fully functional, yet empty. You can find further information here.

Specify substitutions

You can specify template substitutions directly from the command line. Add them at the end of the previous example:

$ projy PythonPackage TowelStuff "author,Emmett Brown" "date,1851-09-24"

Then the substitutes author and date (defaulted to the current day) are defined by the given values, not those computed by Projy. The format of such substitutions should be “key,value”. Neither the key or the value should therefore include a comma. Leading and trailing spaces are removed from both key and value.

To know which substitutions can be overwritten this way, use the -i option as described in the dedicated section. You can add substitutions that are not listed with the -i but they won’t have any effect if the template file does not consider them.

Options

Projy comes with some command line options. Type:

$ projy -l

and you’ll see the list of available templates in your installation. That’s an easy way to copy/paste the name of the template you want to use next.

Type

$ projy -i PythonPackage

and you’ll see the details of the Python package template. It shows the created directories and files, with the substitutions included in the template.