A simple sailing race scoring program.
This program is just beginning its development, so don't expect a working version any time soon.
The main goal of this project is to learn about the state of the art development tools and workflows while still producing something useful.
This means especially using the following:
- Distributed version control (GitHub.com) https://github.com/sturmf/regatta
- Continous integration (Travis-CI) https://travis-ci.org/sturmf/regatta
- Test coverage (Coveralls.io) https://coveralls.io/github/sturmf/regatta
- Code review (ReviewBoard) http://reviewboard.rtfs.org
- Code smells (Landscape.io) https://landscape.io/github/sturmf/regatta/
- Style guide checking (flake8) this combines PEP 0008 and pyflakes
- Planing and issue tracking (JIRA Software) https://regatta.atlassian.net
- Documentation (JIRA Confluence) https://regatta.atlassian.net/wiki
To run the program execute
cd regatta && python3 main.py
To run the style guide checks run
python3 setup.py flake8
or
flake8 regatta
To run the tests execute
python3 setup.py test
or
PYTHONPATH=. py.test-3
To create the documentation run
python3 setup.py build_sphinx
or
cd docs && make html
Feel free to clone the repository on github and submit a pull request. You can also create a reviewboard review request which we will try to complete asap.