OpenClassrooms - Python Developer Path: Project 4

Student: Abdoul Baki Seydou

Date: 31/12/2022

1. Summary
2. Features
3. Basic flow
4. Technologies Used
5. Project Tasks
6. Local Development
   • Prerequisites
   • Setup on macOS/Linux
   • Setup on Windows
   • Running the Application
   • Linting
   • Screenshots

In this project, as a junior freelance developer presented with the first opportunity of a potential client project, the task consists of creating a standalone tournament management application for a local chess club, Castle Chess, that allows the tournament managers to run the entire events offline.

1. Players: Add players and update their ratings.
2. Tournaments: Create, start and resume tournaments.
3. Player Pairings: Using the Swiss tournament system.
4. Reports: Display reports on players, tournament's rounds and matches.

1. Create players.
2. Create a new tournament.
3. Add eight players in the tournament.
4. Start the tournament created and run the rounds.
5. The application generates the pairings automatically.
6. Input match scores: the winner receives 1 point, the loser 0, and 0.5 each for a tie.

• Programming Language: Python
• Libraries: tabulate.
• Database: TinyDB, in Json format.

1. Design Models.
2. Create the menu Views then the Controllers handling the logic of the view.

• Python 3.6 or higher.

1. Clone the Repository

   cd /path/to/put/project/in
   git clone https://github.com/Afudu/P4_OpenClassroom.git
   

2. Move to the folder

   cd P4_OpenClassroom
   

3. Set Up Virtual Environment

   python -m venv venv
   

4. Activate Environment

   source venv/bin/activate 
   

5. Securely upgrade pip

   python -m pip install --upgrade pip 
   

6. Install dependencies

   pip install -r requirements.txt
   

7. To deactivate Environment

   deactivate
   

1. Follow the steps above.

2. To activate the environment:

   .\venv\Scripts\Activate
   

• To run the application:

  python main.py
  
  

The codebase is fully linted and free of errors.

• To Run Linting

  flake8