P4_Chess

Présentation

Ce programme est une version beta d'un script permettant de gérer des tournois d'échecs hors ligne.

Les objectifs de ce programme sont les suivants:

• générer des tournois (gestion des joueurs / matchs / rounds / classement)

• automatiser le classement des joueurs après chaque fin de tournoi

• gérer la base de données des joueurs

• proposer des rapports de statistiques des joueurs et des tournois

Pour commencer

Les instructions ci dessous vous aiderons à exécuter correctement ce programme.

Pré-requis

• Python 3 installé Télécharger Python
• Savoir naviguer dans les dossiers & fichiers à partir d'un terminal.

Installation

Pour un bon fonctionnement, il est préférable d'exécuter le programme dans un environnement virtuel. Pour cela, ci dessous les étapes à suivre:

1. Téléchargement du projet.

   1. Depuis votre terminal, placez vous à l'endroit souhaité:

   cd [chemin d'accès]

   2. Creer un nouveau dossier:

   mkdir [nom de votre dossier]

   3. Copier le programme source:

   git clone https://github.com/JM-Duval/P4_Chess.git

Vous devez voir (depuis votre explorateur) les fichiers suivants: * main.py * requirements.txt, ainsi que les dossiers suivant: controler / model / view.

Dans le dossier controler doit apparaitre les fichiers:

• dataBasePlayersControler.py
• inputUserControler.py
• menuControler.py
• tournamentControler.py

Dans le dossier model doit apparaitre les fichiers:

• dataBasePlayersModel.py
• dataBaseTournamentModel.py
• inputUserModel.py
• match.py
• menuModel.py
• player.py
• round.py
• tournament.py

Dans le dossier view doit apparaitre les fichiers:

• dataBasePlayersView.py
• menuView.py
• tournamentView.py
• inputUserView.py

2. Creer un environnement virtuel.

Depuis windows/mac/linux: python3 -m venv env

3. Activer l'environnement.

Depuis windows: env\Scripts\activate.bat

Depuis mac/linux: source env/bin/activate

Si vous rencontrez des difficultés ou si vous souhaitez plus de détails sur l'installation d'un environnement virtuel, vous pouvez vous reporter à la documentation Python: Documentation Python

4. Installer les paquets.

pip install -r requirements.txt

En executant la commande: pip freeze, vous devez voir apparaitre cette liste:

• flake8==3.9.2
• flake8-html==0.4.1
• importlib-metadata==4.5.0
• Jinja2==3.0.1
• keyboard==0.13.5
• MarkupSafe==2.0.1
• mccabe==0.6.1
• pycodestyle==2.7.0
• pyflakes==2.3.1
• Pygments==2.9.0
• tinydb==4.4.0
• zipp==3.4.1

5. Lancement du programme.

pyhton main.py

Losque vous allez lancer le programme depuis le terminal, vous allez voir apparaitre le menu principale. Il vous suffit ensuite de suivre les indications pour naviguer des les menus et sous menus.

Flake_8

Presentation

flake8 est un outil qui permet de valider un code Python suivant les conventions de codage PEP 8 (Style guide for Python Code) et de pyflakes (détection d'erreurs). Il génère automatiquement des rapports précisant les erreurs et type d'erreur des programmes présents dans le même dossier que celui-ci.

Lancement de Flake_8

A partir de votre dossier de téléchargement (à côté de main.py), vous devez avoir le programme ci dessous:

.flake_8

Depuis votre terminal, lancer ce dernier en tapant :

flake8

Une fois l'exécution du programme terminé, dirigez-vous dans le dossier:

flake-report

Puis ouvrir le fichier:

index.html

Dans ce menu HTML, vous trouverez un rapport indiquant l'ensemble des erreurs (si il y a) de tous les dossiers concernés. Chaque erreur est associé à un code (par exemple E722). Vous trouverez des informations détaillés des codes sur flake8rules.

Fabriqué avec

PyCharm Community Edition 2020.2.3 x64 - Editeur de textes

Auteurs

• JM Duval