jefftriplett / python-packager Goto Github PK

A command-line tool to create Python Packages.

It's intended as a quick way to create new Python packages. It is not a maintenance tool.

Usage:

$ pip install python-packager
$ pypackager <mypackage> [options]

This will create a package in your current directory, complete with setup.py, AUTHORS and LICENSE files.

License files are generated by lice.

All options can be specified on the command-linne or stored in a config file at ~/.pypackager/pypackager.cfg:

(alias of --author-name)

Required. The author's full name

Required. The author's email.

(alias of --license-type)

Required. The license to include in the code. See lice for a list of the available licenses.

Required. The organization licensing the code. Most of the time this will be the same as --author-name

Optional. The directory that will be used as template.

Single files will be rendered using pystache.

The rendering context will contain every setting specified, plus a package_name variable containing the package name.

The special directory __package_name__ will be renamed to the package's name.

(alias of --script-prerender)

Optional. If enabled, the specified script will be called before files are rendered from the skeleton. A typical example is a script creating a virtualenv.

Optional. If enabled, the specified script will be called after files are rendered from the skeleton. A typical example is a script initializing a new VCS repository.

To store your options (so you don't have to type them every time) you can write them into a file called ~/.pypackager/pypackager.cfg:

[author]
name = John Smith
email = [email protected]

[license]
type = bsd3
organization = John Smith

[scripts]
prerender = ~/.pypackager/my_prerender_script.sh
postrender = ~/.pypackager/my_postrender_script.sh

This software should be considered Alpha.

This project is released under the MIT License.