A dummy project to introduce various DevOps tools and Best Practices to Python developers. Follow along with the tutorial on fakeproj.readthedocs.io
pip install .
pip install -r requirements.txt
pip install -e .
pip install pre-commit
pre-commit install
ln -s ../../.githooks/commit-msg .git/hooks/commit-msg
chmod +x .git/hooks/commit-msg
rm .git/hooks/commit-msg.sample
pytest -s -v --cov=fakeproj test/
There are markers for individual modules from the library, eg,
pytest -v -m "goodmodule" --cov=fakeproj test/
Benchmarks can be run locally using asv run
, followed by asv publish
and asv preview
.
The benchmarks are also available to view online at here.
To update the online dashboard by pushing the latest benchmarks, use asv gh-pages
radon cc -a .
xenon --max-absolute B --max-modules B --max-average A .
docstr-coverage .
- Unit Testing (Python 3.6, 3.7, 3.8 on ubuntu:latest)
- Code Coverage
- Code Complexity (Maximum CC of B/B/A)
- Build Testing (Python 3.6, 3.7, 3.8 on {ubuntu, macos, windows}:latest)
This project uses Black for Code Formatting
- Populate Docs