DAI-Lab/cookiecutter-pypackage


DAI Lab's adaptation of cookiecutter-pypackage

License: Other

Language: Python


Cookiecutter PyPackage

Updates https://travis-ci.org/audreyr/cookiecutter-pypackage.svg?branch=master

Cookiecutter 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 2.7, 3.4, 3.5, 3.6
  • Sphinx docs: Documentation ready for generation with, for example, ReadTheDocs
  • Bumpversion: Pre-configured version bumping with a single command
  • Auto-release to PyPI when you push a new tag to master (optional)
  • Command line interface using Click (optional)

Build Status

Linux:

Linux build status on Travis CI

Windows:

Windows build status on Appveyor

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/audreyr/cookiecutter-pypackage.git

Then:

  • Create a repo and put it there.
  • Add the repo to your Travis-CI account.
  • Install the dev requirements into a virtualenv. (pip install -r requirements_dev.txt)
  • 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.
  • Add the repo to your ReadTheDocs account + turn on the ReadTheDocs service hook.
  • Release your package by pushing a new tag to master.
  • Add a requirements.txt file that specifies the packages you will need for your project and their versions. For more info see the pip docs for requirements files.
  • 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

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.

Project Statistics

Sourcerank 4
Repository Size 409 KB
Stars 0
Forks 1
Watchers 2
Open issues 3
Dependencies 23
Contributors 73
Tags 0
Created
Last updated
Last pushed

Top Contributors See all

Audrey Roy Greenfeld Elias Dorneles Daniel Roy Greenfeld Chris Erickson Diane DeMers Chen pyup.io bot kartik sundararajan Micah Smith Katia Lira Trey Hunner Raymond Wanyoike Jonan Scheffler Evan Palmer Erwin Janssen Wes Turner Tony Narlock Mandeep Bhutani Kevin Ndung'u Adam Johnson Manu Phatak

Something wrong with this page? Make a suggestion

Last synced: 2018-04-09 19:49:07 UTC

Login to resync this repository