Skip to content

A starting spot for python projects. Embracing open source elements.

License

Notifications You must be signed in to change notification settings

SyntaxRules/python-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

python-starter

A starting spot for python projects. Embracing open source elements.

Documentation status Build Status codecov

Documentation: http://python-starter.readthedocs.io/en/latest/

Project Details

Structure

This project follows the structure suggested in Jan-Philip Gehrcke's Blog.

Versioning

This project uses Semver as its versioning scheme.

Tests

Basic acceptance tests are in the tests folder. You can run these tests by running python setup.py test. The unit tests are in line with the code. You can run all the tests with python -m pytest ..

The tests are ran automatically when they are submitted to github via travici.org. Your tests must work here to be considered passing, it doesn't matter if they run on your local machine, if they fail on TravisCI, then they will not be accepted into matser.

Coverage is also determined by TravisCI and reported to CodeCov.

Documentation

Documentation is inline (like unit tests) and deployed with Read the Docs. When editing code, please include documentation for your changes. Add any new files to the mkdocs.yml file. The documentation is automatically built and installed.

The documentation is found here: http://python-starter.readthedocs.io/en/latest/

You can test the docs locally by installing mkdocs and running mkdocs serve in the root directory of the project source. This will launch a server locally that you can use to view what the docs will look like when deployed. The pages update automatically when changes are made.

You can add a page to the documentation by editing the mkdocs.yml file in the source repo. See Adding Pages.