Welcome to Biskotaki documentation!¶
Project generated from the https://github.com/boromir674/cookiecutter-python-package/tree/master/src/cookiecutter_python cookiecutter
biskotaki python package
TODO Document a Great Feature
TODO Document another Nice Feature
Tested against multiple platforms and python versions
Here are some useful notes related to doing development on 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
Automation, using tox, driven by single tox.ini file
CI Pipeline, running on Github Actions, defined in .github/
Job Matrix, spanning different platform’s and python version’s
Platforms: ubuntu-latest, macos-latest
Python Interpreters: 3.6, 3.7, 3.8, 3.9, 3.10
Parallel Job execution, generated from the matrix, that runs the Test Suite
You need to have Python installed.
Using pip is the approved way for installing biskotaki.
python3 -m pip install biskotaki
TODO Document a use case
Free software: GNU Affero General Public License v3.0