cookiecutter-simple-pypackage

Cookiecutter simple template for a Python package.

Features

• Testing setup with unittest and python setup.py test or py.test
• Travis-CI: Ready for Travis Continuous Integration testing
• Tox testing: Setup to easily test for Python 3.6
• Bumpversion: Pre-configured version bumping with a single command
• Use Pipenv, the officially recommended Python packaging tool from Python.org
• Auto-release to PyPI when you push a new tag to master (optional)
• Command line interface using Click (optional)

Quickstart

Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):

    $ pip install -U cookiecutter

Generate a Python package project:

    cookiecutter https://github.com/oldani/cookiecutter-simple-pypackage

Then:

• Create a repo and put it there.
• Add the repo to your Travis-CI account.
• Install the dev requirements. (pipenv install --dev) not needs for virtualenv.
• Register your project with PyPI.
• Run the Travis CLI command travis encrypt --add deploy.password to encrypt your PyPI password in Travis config and activate automated deployment on PyPI when you push a new tag to master branch.
• Start developing your package.
• Release your package by pushing a new tag to master.
• Activate your project on pyup.io.

For more details, see the cookiecutter-pypackage tutorial.

Not Exactly What You Want?

Don't worry, you have options:

Similar Cookiecutter Templates

• audreyr/cookiecutter-pypackage: The original pypackage.

• Nekroze/cookiecutter-pypackage: A fork of audreyr/cookiecutter-pypackage with a PyTest test runner, strict flake8 checking with Travis/Tox, and some docs and setup.py differences.

• ardydedase/cookiecutter-pypackage: A fork with separate requirements files rather than a requirements list in the setup.py file.

• 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.