https://github.com/pablolec/oc_chess_club
Chess tournament manager CLI made for OpenClassrooms studies
https://github.com/pablolec/oc_chess_club
chess cli python typer
Last synced: about 2 months ago
JSON representation
Chess tournament manager CLI made for OpenClassrooms studies
- Host: GitHub
- URL: https://github.com/pablolec/oc_chess_club
- Owner: PabloLec
- License: mit
- Created: 2021-04-06T11:36:25.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-03T15:22:37.000Z (over 3 years ago)
- Last Synced: 2025-06-08T23:36:43.605Z (4 months ago)
- Topics: chess, cli, python, typer
- Language: Python
- Homepage: https://pablolec.github.io/oc_chess_club
- Size: 1.56 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# oc_chess_club [](https://github.com/PabloLec/oc_chess_club/releases/) [](https://github.com/PabloLec/oc_chess_club/blob/main/LICENCE) [](https://github.com/psf/black)
:books: Made for an [OpenClassrooms](https://openclassrooms.com) 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](https://github.com/tiangolo/typer/) for the CLI part and [TinyDB](https://github.com/msiemens/tinydb) for the lightweight database.
You will need **Python 3.9+** as the project type hints generics from standard collections. (See [PEP 585](https://www.python.org/dev/peps/pep-0585/))
## Installation
#### :penguin: Linux / :apple: macOS
```console
python3 -m venv env
source env/bin/activate
python3 -m pip install oc-chess-club
```
#### :framed_picture: Windows
```console
py3 -m venv env
.\env\Scripts\activate
py3 -mpip install oc-chess-club
```
## Usage
To start the CLI, simply type:
```console
python3 -m oc_chess_club
```
To learn more, please refer to the [documentation](https://pablolec.github.io/oc_chess_club) (:fr:).
## Flake8
To generate a Flake8 HTML report you will need [flake8](https://github.com/PyCQA/flake8) and [flake8-html](https://github.com/lordmauve/flake8-html). Both are present in this project's dev dependencies.
Then, go to project's main directory and type:
```console
python3 -m flake8 --format=html --htmldir=docs/flake-report
```
## License
This project is licensed under the terms of the MIT license.