biskotaki 0.1.0

Project generated from the https://github.com/boromir674/cookiecutter-python-package/tree/master/src/cookiecutter_python cookiecutter

BISKOTAKI

Project generated from the https://github.com/boromir674/cookiecutter-python-package/tree/master/src/cookiecutter_python cookiecutter

Code: https://github.com/boromir674/biskotaki

Docs: https://biskotaki.readthedocs.io/en/master/

PyPI: https://pypi.org/project/biskotaki/

CI: https://github.com/boromir674/biskotaki/actions/

Features

1. biskotaki python package

   1. TODO Document a Great Feature

   2. TODO Document another Nice Feature

2. Tested against multiple platforms and python versions

Development

Here are some useful notes related to doing development on this project.

1. Test Suite, using pytest, located in tests dir

2. Parallel Execution of Unit Tests, on multiple cpu’s

3. Documentation Pages, hosted on readthedocs server, located in docs dir

4. Automation, using tox, driven by single tox.ini file

   1. Code Coverage measuring

   2. Build Command, using the build python package

   3. Pypi Deploy Command, supporting upload to both pypi.org and test.pypi.org servers

   4. Type Check Command, using mypy

   5. Lint Check and Apply commands, using isort and black

5. CI Pipeline, running on Github Actions, defined in .github/

   1. Job Matrix, spanning different platform’s and python version’s

      1. Platforms: ubuntu-latest, macos-latest

      2. Python Interpreters: 3.6, 3.7, 3.8, 3.9, 3.10

   2. Parallel Job execution, generated from the matrix, that runs the Test Suite

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

• GNU Affero General Public License v3.0

License

• Free software: GNU Affero General Public License v3.0