Skip to content

README.fr.md

Latest commit

 

History

History
86 lines (51 loc) · 1.79 KB

README.fr.md

File metadata and controls

86 lines (51 loc) · 1.79 KB

Python Togo API Version 2.1.0

API officielle de Python Togo. Ce projet centralise les fonctionnalites backend et sert de base commune pour les evolutions de la plateforme.

Objectif

  • Fournir une API stable et structuree avec FastAPI
  • Centraliser les endpoints du projet
  • Faciliter les contributions de la communaute

Contribution

1) Forker le projet

Forker ce depot, puis cloner votre fork en local :

git clone https://github.com/<votre-utilisateur>/pythontogo_api.git
cd pythontogo_api

Run avec script (Linux/MacOS/wsl)

Assurez-vous d'avoir Docker installé et en cours d'exécution sur votre machine.

# Copier le fichier d'exemple et remplir les variables d'environnement 

cp app/.env.example app/.env

# Linux/MacOS : Rendre le script d'entrée exécutable
chmod +x entrypoint.sh

# Lancer le script pour démarrer l'API avec Docker
./entrypoint.sh

Developper en local

2.1) installer les dependances et Configurer l'environnement

## Installer les dependances

pip install -r requirements.txt

## Copier le fichier d'exemple et remplir les variables d'environnement 

cp app/.env.example app/.env

2.2) Lancer les migrations

python -m app.database.migrations

ou

python3 -m app.database.migrations

Verifier au besoin la configuration de migration dans le dossier/fichier Alembic du projet.

2.3) Demarrer l'API en developpement

fastapi dev app/main.py --port 8000

Vous pouvez remplacer 8000 par n'importe quel port disponible.

Version

Cette branche contient la nouvelle version du projet.

Bonnes pratiques de contribution

  • Creer une branche par fonctionnalite/correctif
  • Faire des commits clairs
  • Ouvrir une Pull Request avec une description precise
  • Ajouter/mettre a jour les tests si necessaire