cookiecutter-pypackage

Cookiecutter template for a Python package. See https://github.com/audreyr/cookiecutter.

Free software: BSD license
Vanilla testing setup with unittest and python setup.py test
Travis-CI: Ready for Travis Continuous Integration testing
Tox testing: Setup to easily test for Python 2.6, 2.7, 3.3
Sphinx docs: Documentation ready for generation with, for example, ReadTheDocs

Usage

Generate a Python package project:

cookiecutter https://github.com/audreyr/cookiecutter-pypackage.git

Then:

Create a repo and put it there.
Add the repo to your Travis CI account.
Add the repo to your ReadTheDocs account + turn on the ReadTheDocs service hook.
Release your package the standard Python way. Here's a release checklist: https://gist.github.com/audreyr/5990987

Not Exactly What You Want?

Don't worry, you have options:

Similar Cookiecutter Templates

Nekroze/cookiecutter-pypackage: A fork of this with a PyTest test runner, strict flake8 checking with Travis/Tox, and some docs and setup.py differences.
lucuma/cookiecutter-pypackage: Full py.test integration: custom .coveragerc file and changes in the Makefile and Travis/Tox config files. Used for several released packages.
Also see the network and family tree for this repo. (If you find anything that should be listed here, please add it and send a pull request!)

Fork This / Create Your Own

If you have differences in your preferred setup, I encourage you to fork this to create your own version. Or create your own; it doesn't strictly have to be a fork.

Once you have your own version working, add it to the Similar Cookiecutter Templates list above with a brief description.
It's up to you whether or not to rename your fork/own version. Do whatever you think sounds good.

Or Submit a Pull Request

I also accept pull requests on this, if they're small, atomic, and if they make my own packaging experience better.

native2k/cookiecutter-pypackage

ErrorLooks like something went wrong!

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages