chenyu93 / python-skeleton-project

Skeleton project for python applications with py.test testing, sphinx docs, Travis CI, and pypi publishing.

python-skeleton-project

python-skeleton-project is a barebones repository intended as a quick-start for new python applications which plan to utilize the following functionalities:

• Unit testing with pytest
• Continuous integration testing with Travis CI
• Packaging and publishing to PyPi
• Documentation with Sphinx and Github Pages

Documentation

Documentation can be found at the github pages here

Dependencies

python-skeleton-project is tested to work under Python 3.x. See the requirements via the following command:

cat requirements.txt

Installation

python-skeleton-project is currently available on the PyPi's repository and you can install it via pip:

pip install -U python-skeleton-project

If you prefer, you can clone it and run the setup.py file. Use the following commands to get a copy from GitHub and install all dependencies:

git clone https://github.com/aagnone3/python-skeleton-project.git
cd python-skeleton-project
pip install .

Or install using pip and GitHub:

pip install -U git+https://github.com/aagnone3/python-skeleton-project.git

Local Testing

make test

Travis Testing

The Makefile, .travis.yml file and .ci directory contain the structure necessary to have Travis test the repository upon all branch updates. Some additional steps, however, are needed:

• Enable the repository to be monitored by Travis via your Travis profile.
• Generate a Github app token, and assign it to the (private) environment variable ${GITHUB_TOKEN} in the Travis environment.