README.md

OpenClassrooms Projet P4

• Objectif
• Compétences
• Technologies
• Requirements
• Architecture
• Configuration locale
• Présentation

Objectif

Le club d'échecs local nous a contacté pour développer une programme logiciel Python permettant de gérer leurs tournois de façon hors ligne et en ligne de commande.

Compétences acquises

• Utiliser la programmation orientée objet pour développer un programme Python
• Écrire un code Python robuste en utilisant la PEP 8
• Structurer le code d'un programme Python en utilisant un design pattern

Technologies Utilisées

• Python3
• Pytest
• Flake8
• TinyDB

Requirements

• flake8
• flake8-html
• pytest
• tinydb

Architecture et répertoires

Project
├── core : package principale de notre application
│   ├── controller.py
│   ├── model.py
│   ├── parse_validate_tools.py
│   ├── persistence.py
│   ├── sorters.py
│   ├── vue.py
│
├── main.py : script principal destiné à lancer l'application
│
├── flake8-rapport : répertoire de résultats flake8
├── .flake8 : fichier de configuration flake8
│
├── tests : répertoire de tests
├── ressources : répertoire contenant la base de donnée initiale db.json
├── requirements.txt

Configuration locale

Installation

1. Récupération du projet sur votre machine locale

Clonez le repository sur votre machine.

git clone https://github.com/GDSDC/OpenclassroomsProject-P4.git

Accédez au répertoire cloné.

cd OpenclassroomsProject-P4

2. Création d'un environnement virtuel

Créez l'environnement virtuel env.

python3 -m venv env

3. Activation et installation de votre environnement virtuel

Activez votre environnement virtuel env nouvellement créé.

source env/bin/activate

Installez les paquets présents dans la liste requirements.txt

pip install -r requirements.txt

Utilisation

Lancer simplement le script python main.py présent à la source du dossier de travail.

python3 main.py

Présentation