python_template

This is the template for WRAIR python projects that will help you quickly setup a base project that you can easily expand upon.

Features

• .travis.yml to hook in with https://travis-ci.org
• .travis.yml pushes to https://coveralls.io
• sphinx docs directory for your documentation that can be hooked into Read The Docs
• tox.ini to allow you to easily run tests through different python environments
• tests directory stub
• python package directory
• setup.py installation script

How To Use

1. Clone this repo

2. Rename the directory to your project name

3. Modify the git origin remote so it points to your new project's github project

4. Anywhere you see python_template you will need to rename that to your project name. The following should work to rename all python_template to your_project

   find . -path ./.git -prune -o -type f -exec sed -i 's/python_template/your_project/g' {} \;

Travis CI

1. Head over to https://travis-ci.org
2. You should be able to sign up with your github account here.
3. On the left side of the page you will see 'My Repositories', 'Recent' and a plus symbol. Click the plus symbol to list all your github repos.
4. Click the 'sync' button to make sure all your github repos are synced such that travis can see them
5. Find your project in the list and slide the toggle switch to green

Coveralls IO

1. Head over to https://coveralls.io
2. You should be able to sign up with your github account here.
3. Click Add Repos
4. Click sync github repos
5. Find your project and slide the toggle switch to On

Read The Docs

1. Head over to https://readthedocs.org
2. Sign up for an account
3. Click import a project
4. Select Import from GitHub
5. Click sync your github projects
6. Find your project and click Create
7. Click Next