Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 1.42 KB

README.md

File metadata and controls

47 lines (29 loc) · 1.42 KB

CookieCutter Pip-Project

A cookiecutter template for python projects intended to be pip-installed

cookiecutter

Inspired by: sloria

Using CookieCutter for your project

$ pip install cookiecutter
$ cookiecutter https://github.com/wdm0006/cookiecutter-pipproject.git

You will be asked about your basic info (name, project name, app name, etc.). This info will be used in your new project.

Publishing your project to pypi

There are two ways to publish your project:

  • the manual way, outlined here
  • and with pypi-publisher ppp

Goals

The goal of this project is simply to take some of the boiler plate out of creating a new python project. It is intended to stay pretty minimal, but will eventually contain everything needed to make a project that includes:

  • Sphinx documentation
  • Installable via pip in pypi
  • Testing via Nose and Coverage
  • Any other appropriate tooling for a medium sized project

Contributing

The intent of this project is to stay fairly lean, but if you have any suggestions or would like to help out, please let me know.

License

BSD licensed.