Proust

在线时间序列分析

设置开发环境

[插入关于使用某些Python环境的典型语言]。在该环境中，运行以下命令

# Install editable version of code
pip install -e .

# Install testing dependencies
pip install -e .[testing]

# Install pre-commit hooks
pre-commit install

贡献

我们使用pre-commit工具来自动检查（并在可能的情况下修复）Python警告、错误和风格。这将在git commit时自动运行，要么无问题通过，要么更改文件，并/或要求您进行修复。如果测试未通过，则提交失败（好事！保持历史清晰）。

测试

我们还使用pytest，我们鼓励您在贡献之前运行（并行测试：pytest -n auto）。

文档

要更新doc覆盖徽章，请运行

docstring-coverage -b .github/badges/docstring_coverage.svg .

版本控制

要更新版本，请运行

bumpversion [major|minor|patch]