Start by cloning the Tutor repository:
git clone https://github.com/overhangio/tutor.git cd tutor/
pip install -r requirements/dev.txt
Yes, there are very few unit tests for now, but this is probably going to change.
Tutor code formatting is enforced by black. To check whether your code changes conform to formatting standards, run:
And to automatically fix formatting errors, run:
Static error detection is performed by pylint. To detect errors, run:
Generating the documentation
pip install -r requirements/docs.txt cd docs/ make html
You can then browse the documentation with:
Releasing a new version
- Bump the
- Replace "Latest" by the version name in CHANGELOG.md.
- Create a commit with the version changelog.
make release(this assumes that there are two remotes named "origin" and "overhangio")
After a regular push to
make nightly to update the "nightly" tag.