autopew is currently hosted on GitHub at; collaborator access can be granted to interested parties. If you’re new to Git or GitHub, there are some useful guides on the GitHub Website.

Development Installation

To access and use the development version, you can either clone the repository or install via pip directly from GitHub:

pip install git+git://

Branches and GitFlow

There are two main git-branches for autopew:

  • master is the latest stable release.
  • develop is the development branch.

The Git workflow is based on GitFlow, where releases are branched from develop prior to being integrated into master. Pull requests should be made against the develop branch.


Documentation is currently live on <>`__ , but can also be built and viewed locally using instructions below. The documentation is built using sphinx, and most pages are written in reStructuredText. A quick reference can be found here.

Documentation for autopew is in the docs directory. From this directory, documentation can be built as follows:

To build documentation on windows:

# to build and view the html version:
make html && cd ./build/html/ && index.html && cd ../..
# or, to build and view the latex-pdf version:
make latex && cd ./build/latex/ && make.bat && autopew.pdf && cd ../..

Alternatively, there is a default build batch file makeviewhtml.bat also located in the docs directory, which executes the commands above and will automatically build the docs and open the landing page:

# to build and view the html version:


If you clone the source repository, unit tests can be run using pytest from the root directory after installation:

python test

Continuous Integration

Test Status Test Coverage

There are also some active continuous integration tools for autopew, including automated unit-testing on Travis-CI and test coverage analysis on Codecov. The details for each of these are listed below.


The Travis-CI page for autopew can be found at

Code Coverage

The coveralls page for autopew can be found at