Welcome to Biskotaki documentation!¶
BISKOTAKI
Project generated using https://github.com/boromir674/cookiecutter-python-package
Features¶
biskotaki python package
TODO Document a Great Feature
TODO Document another Nice Feature
Tested against multiple platforms and python versions
Development¶
python3 -m pip install --user 'tox<4'
OR: `pipx install tox`
Then, to see all out-of-the-box available tox commands:
tox -a
OR `tox -av` for showing description of each command
Development Notes¶
Testing, Documentation Building, Scripts, CI/CD, Static Code Analysis for this project.
Test Suite, using pytest, located in tests dir
Parallel Execution of Unit Tests, on multiple cpu’s
Documentation Pages, hosted on readthedocs server, located in docs dir
CI/CD Pipeline, running on Github Actions, defined in .github/
Test Job Matrix, spanning different platform’s and python version’s
Platforms: ubuntu-latest, macos-latest, windows-latest
Python Interpreters: 3.8, 3.9, 3.10, 3.11
Continuous Deployment
Production
Staging
Python Distristribution to test.pypi.org, on “pre-release” tags v*-rc, pushed to release branch
Configurable Policies for Docker, and Static Code Analysis Workflows
Automation, using tox, driven by single tox.ini file
Prerequisites¶
You need to have Python installed.
Quickstart¶
Using pip is the approved way for installing biskotaki.
python3 -m pip install biskotaki
TODO Document a use case
License¶
License¶
Free software: GNU Affero General Public License v3.0