Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 1.95 KB

README.rst

File metadata and controls

62 lines (45 loc) · 1.95 KB
Raw

cookiecutter-pypackage

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

  • Free software: BSD license
  • Pytest runner: Supports unittest, pytest, nose style tests and more
  • Travis-CI: Ready for Travis Continuous integration testing
  • Tox testing: Setup to easily test for python 2.6, 2.7, 3.3 and PyPy
  • Sphinx docs: Documentation raedy for generation with, for example, ReadTheDocs
  • Wheel support: Use the newest python package distribution standard from the get go

Usage

Generate a Python package project:

cookiecutter https://github.com/Nekroze/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.
  • Run tox to make sure all tests pass.
  • Release your package the standard Python way.

Not Exactly What You Want?

Don't worry, you have options:

Similar Cookiecutter Templates

for testing and other minor changes.

Fork This

If you have differences in your preferred setup, I encourage you to fork this to create your own version. Once you have your fork working, add it to the Similar Cookiecutter Templates list with a brief explanation. It's up to you whether or not to rename your fork.

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.