Online time series analysis
Project description
Proust
Online time series analysis
Setting up a development environment
[Insert typical language about using some python environment]. Within that environment, run the following:
# Install editable version of code
pip install -e .
# Install testing dependencies
pip install -e .[testing]
# Install pre-commit hooks
pre-commit install
Contributing
We use the pre-commit tools to automatically lint (and fix, where possible)
for Python warnings, errors, and style. This runs automatically on git commit
and will either pass with no issue, make changes to files, and / or ask you to
make fixes. If the tests don't pass, the commit fails (a good thing! Keeps
history clean).
Testing
We also use pytest, which we encourage you to run before contributing (pytest -n auto for parallelized testing).
Documentation
To update the doc coverage badge, run
docstring-coverage -b .github/badges/docstring_coverage.svg .
Versioning
To update the version, run
bumpversion [major|minor|patch]
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
