Did you find any of these instructions confusing? Edit this file and submit a pull request with your improvements!

Step 1: Install Cookiecutter

First, create a virtualenv for your new package:

virtualenv ~/.virtualenvs/mypackage

Here, mypackage is the name of the package that you’ll create.

Activate your environment

source bin/activate

On Windows

> \path\to\env\Scripts\activate

Install cookiecutter

pip install cookiecutter

Step 2: Generate Your Package

Now it’s time to generate your Python package.

Use cookiecutter, pointing it at the cookiecutter-pypackage repo:

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

You’ll be asked to enter a bunch of values to set the package up. If you don’t know what to enter, stick with the defaults.

Step 3: Create a GitHub Repo

Create a repo and put your package there.

Be sure to add you environment folder into the .gitignore file.

This can be accomplished with:

git init .
git add .
git commit -m "Initial skeleton."
git remote add origin git@github.com:myusername/mypackage.git
git push -u origin master

Where myusername and mypackage are the adjusted for the specific project.

You’ll need a ssh key to push the repo. You can Generate a key or Add existing one.

Step 4: Install Dev Requirements

Make sure you are in the folder containing the requirements_dev.txt file.

Install the new project’s local development requirements into a virtualenv:

pip install -r requirements_dev.txt

If you have issues building the wheel for cryptography. Make sure that the required dependencies are installed. Follow the `Cryptography Instruction`_ for your OS

Step 5: Set Up Travis CI

Travis CI org is a continuous integration tool used to prevent integration problems. Every commit to the master branch will trigger automated builds to create the necessary files to run the application.

Login using your Github credentials.

Add the public repo to your Travis CI account.

[#] For private projects got to Travis CI com

Go to your terminal and run the script travis_pypi_setup.py. It will:

  • Encrypt your PyPI password in your Travis config.
  • Activate automated deployment on PyPI when you push a new tag to master branch.

See Travis/PyPI Setup.

Step 6: Set Up ReadTheDocs

`ReadTheDocs`_ hosts documentation for the open source community. Think of it as Continuous Documentation.

Log into your account at `ReadTheDocs`_ .

Import the repository

In your GitHub repo settings > Webhooks & services, turn on the ReadTheDocs service hook.

Step 7: Release on PyPI

The Python Package Index or `PyPI`_ is the official third-party software repository for the Python programming language. Python developers intend it to be a comprehensive catalog of all open source Python packages.[1]

Release your package the standard Python way.

`PyPI Help`_ submitting a package.

Here’s a release checklist: https://gist.github.com/audreyr/5990987