CLI to manage tournaments and players for a chess club
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for oc_chess_club-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4dab3ae67e17f02154e9d9ecaf6d3a4b1b7aac0d50ff31f82fbddacceeda6d22 |
|
MD5 | 456f6a692086a3c94815cbc322422d8f |
|
BLAKE2b-256 | 2302087861e785caf6c7b4ecffbed3a6d2b3d462d9558d029cc7203b95556ab2 |