Skip to content

ekampf/cookiecutter-pypackage

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cookiecutter-pypackage

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

  • Free software: BSD license
  • VirtualEnv support: All Makefile commands use a virtual env set in .venv folder under the project root
  • Travis-CI: Ready for Travis Continuous integration testing
  • Tox testing: Setup to easily test for python 2.7, 3.4 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
  • Support for Automatic Build Versioning -

Usage

Generate a Python package project:

cookiecutter https://github.com/ekampf/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.

Releases

No releases published

Packages

No packages published

Languages

  • Python 43.0%
  • Makefile 33.3%
  • Batchfile 23.6%
  • Shell 0.1%