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.
To access and use the development version, you can either clone the repository or install via pip directly from GitHub:
pip install git+git://github.com/morganjwilliams/autopew.git@develop#egg=autopew
Branches and GitFlow¶
There are two main git-branches for
masteris the latest stable release.
developis 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
Documentation is currently live on ReadtheDocs.org <https://autopew.readthedocs.io>`__ , 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.
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: makeviewhtml.bat
If you clone the source repository, unit tests can be run using pytest from the root directory after installation:
python setup.py test
There are also some active continuous integration tools for
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
autopewcan be found at travis-ci.org/morganjwilliams/autopew.
The coveralls page for
autopewcan be found at coveralls.io/github/morganjwilliams/autopew.