chess-tournament 0.1.0

A chess tournament software in Python

Chess Tournament Software

A standalone, offline Python application to manage chess tournaments and players — using the MVC architecture and a CLI interface.

---

Table of Contents

• Installation
• Execution
• Makefile Commands
• Tests
• Linting & Formatting
• Pre-commit Hooks
• Code Architecture
• Features
• Author

---

Installation

To configure and run the program, follow the steps below:

1.Clone the repository:

If you haven't already cloned the repository, use the following command:

git clone https://gitlab.com/thi26/chess-tournament-software.git
cd chess-tournament-software

2.Create and activate a virtual environment:

python -m venv venv

• On Windows:

.\venv\Scripts\activate

• On mac OS/Linux:

source venv/bin/activate

3.Install the project and development dependencies:

pip install -e ".[dev]"

Includes development tools like black, flake8, pytest, and pre-commit.

Execution

To start the application (after activation of your virtualenv):

chess

Optional flags:

chess --quiet # Reduces console output

Makefile Commands

This project includes a Makefile to simplify your workflow:

make install-dev   # Install the app + dev dependencies
make test          # Run all tests
make lint          # Lint code with flake8
make format        # Format code with black
make pre-commit    # Run all pre-commit hooks
make clean         # Remove cache and temporary files

Tests

Tests are located in the tests/ folder and use pytest:

make test

A test report in HTML is generated automatically in pytest-report/ during GitLab CI.

Linting & Formatting

To ensure consistent code style:

Lint with Flake8:

make lint

Auto-format with Black:

make format

Pre-commit Hooks

The project uses pre-commit to check code before committing:

make pre-commit

This runs checks like black, flake8, etc., on staged files before allowing the commit.

Code Architecture

The application follows the Model-View-Controller (MVC) pattern to ensure maintainable and testable code.

Features

Player Management: Add, edit, list players

Tournament Management: Create tournaments, pair rounds, record match results

Reports: Generate player and tournament reports

Author

@Thi26, OpenClassrooms student Training: Python Application Developer