Skip to content

Jliezed/oc_project_4_chess_game

Repository files navigation

oc OOP mvc TinyDB flake8


OC - PROJECT N°4 - CHESS GAME TOURNAMENT TRACKER

Track Players' Scores during a Chess Game tournament: 8 players / 4 rounds / 16 matches.

chess-game-readme By Hassan Pasha

About The Project

Main Menu of the Chess Game Tournament Tracker:

  • Creation : Add a new Player or Tournament in the database
  • Database : Display Player or Tournament information
  • Tournament Tracker : Enter to Tournament Tracker Menu for a specific Tournament saved in the database
  • Reset: Reset the Database (Players and Tournaments Tables)

chess game tournament tracker main menu

enter 'pla' : Display list of players by alphabet
chess game tournament tracker main menu list players alphabet

enter 'plr' : Display list of players by rank
chess game tournament tracker main menu list players rank

enter 'pi' : Access player information
chess game tournament tracker main menu player information

enter 'tl' : Display list of tournaments
chess game tournament tracker main menu list tournaments

enter 'ti' : Access tournament information
chess game tournament tracker main menu tournament information

Tournament Tracker Menu :

  • Players : Add player to the tournament, display info, modify rank and remove player -> Add 8 players to the tournament to start record scores

chess game tournament tracker main menu

Tournament Tracker Menu - Start Record :

When 8 players added to the tournament, records can be started:

  • Players :
    • Display players information
    • Modify rank, only available if "record" of the first round not yet saved in the database
    • Reset Players
  • Start Rounds : enter scores for each matches of each rounds (4 matches per round)
  • Results : display tournament results when all rounds recorded
  • Reports : get more information about rounds and matches

chess game tournament tracker main menu

enter 'record' :
-Start generate Rounds and Matches

chess game tournament tracker main menu tournament information

- Enter scores for each match
chess game tournament tracker main menu tournament information

Enter 'results': Get results of the tournament
chess game tournament tracker main menu tournament information

(back to top)

Built With

(back to top)

Getting Started

Installation & Running the script

  1. Clone the repo
    git clone https://github.com/Jliezed/oc_project_4_chess_game.git

Create and activate a virtual environment

  1. Go to your project directory
    cd /oc_project_4_chess_game
  2. Install venv library (if not yet in your computer)
    pip install venv
  3. Create a virtual environment
    python -m venv env
  4. Activate the virtual environment
    source env/bin/activate

Install packages & Run the program

  1. Install the packages using requirements.txt
    pip install -r requirements.txt
  2. Run the script using the terminal
    python main.py

Generate Flake8

  1. Generate a new Flake8 report
    flake8 --format=html --htmldir=flake-report

(back to top)

Outputs

Database JSON File

The program generate a JSON file to keep track of players and tournaments information :

(back to top)

Releases

No releases published

Packages

No packages published