oc-chess-club 1.0.0

CLI to manage tournaments and players for a chess club

oc_chess_club

:books: Made for an OpenClassrooms studies project.

oc_chess_club manages tournaments and players for a chess club.

---

Have a look at the documentation

---

Demo

Dependencies

Main dependencies are typer for the CLI part and TinyDB for the lightweight database.

You will need Python 3.9+ as the project type hints generics from standard collections. (See PEP 585)

Installation

:penguin: Linux / :apple: macOS

python3 -m venv env
source env/bin/activate
python3 -m pip install oc-chess-club

:framed_picture: Windows

py3 -m venv env
.\env\Scripts\activate
py3 -mpip install oc-chess-club

Usage

To start the CLI, simply type:

python3 -m oc_chess_club

To learn more, please refer to the documentation (:fr:).

Flake8

To generate a Flake8 HTML report you will need flake8 and flake8-html. Both are present in this project's dev dependencies.

Then, go to project's main directory and type:

python3 -m flake8 --format=html --htmldir=docs/flake-report

License

This project is licensed under the terms of the MIT license.