cookiecutter-pylibrary's Introduction

cookiecutter-pylibrary

Cookiecutter template for a Python python library.

This template is much simpler than the one of ionelmc template.

Requirements

Projects using this template have these minimal dependencies:

Cookiecutter - just for creating the project
Tox - for running the tests
Setuptools - for building the package, wheels etc. Now-days Setuptools is widely available, it shouldn't pose a problem :)

To get quickly started on a new system, just install setuptools and then install pip. That's the bare minimum to required install Tox and Cookiecutter. To install them, just run this in your shell or command prompt:

pip install tox cookiecutter

Usage

First generate your project:

cookiecutter gh:mvmocanu/cookiecutter-pylibrary

You will be asked for these fields:

Template variable	Default	Description
`project_name`	"Nameless"	Verbose project name, used in headings (docs, readme, etc).
`package_name`	"nameless"	Python package name (whatever you would import).
`project_url`	"http://github.com/pbs/python-nameless"	Repository URL where the source code is hosted
`docs_url`	"http://open.pbs.org"	The place where the documentation lives

Recommend Projects