|
| 1 | +# INSTALLATION — WorldBoss Discord Bot |
| 2 | + |
| 3 | +--- |
| 4 | + |
| 5 | +## 🧩 Prérequis |
| 6 | + |
| 7 | +Avant de commencer, assure-toi d’avoir installé : |
| 8 | +- Python 3.12+ |
| 9 | +- pip (installé par défaut avec Python) |
| 10 | +- Git |
| 11 | +- MySQL ou MariaDB |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## ⚙️ 1. Cloner le projet |
| 16 | +``` |
| 17 | +git clone https://github.com/<ton-username>/WorldBoss.git |
| 18 | +cd WorldBoss |
| 19 | +``` |
| 20 | + |
| 21 | +--- |
| 22 | + |
| 23 | +## 🧱 2. Créer et activer l’environnement virtuel |
| 24 | +``` |
| 25 | +python3 -m venv .venv |
| 26 | +source .venv/bin/activate # sous Linux / macOS |
| 27 | +# ou : |
| 28 | +.venv\Scripts\activate # sous Windows |
| 29 | +``` |
| 30 | + |
| 31 | +--- |
| 32 | + |
| 33 | +## 📦 3. Installer les dépendances |
| 34 | +``` |
| 35 | +pip install --upgrade pip |
| 36 | +pip install -r requirements.txt |
| 37 | +``` |
| 38 | + |
| 39 | +--- |
| 40 | + |
| 41 | +## 🔐 4. Créer le fichier .env |
| 42 | + |
| 43 | +Crée un fichier .env à la racine du projet (récupérer `.env.example`) : |
| 44 | +``` |
| 45 | +DISCORD_TOKEN=ton_token_discord |
| 46 | +DATABASE_URL=mysql+pymysql://user:password@localhost/worldboss |
| 47 | +``` |
| 48 | + |
| 49 | +> ⚠️ Remplace user, password et worldboss par tes identifiants MySQL réels. |
| 50 | +
|
| 51 | +--- |
| 52 | + |
| 53 | +## 🗄️ 5. Initialiser la base de données |
| 54 | +Tu peux créer la base de données manuellement via MySQL : |
| 55 | +``` |
| 56 | +mysql -u root -p |
| 57 | +CREATE DATABASE worldboss CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; |
| 58 | +``` |
| 59 | + |
| 60 | +Ensuite, initialise les tables avec le script : |
| 61 | +``` |
| 62 | +PYTHONPATH=src python -m src.database.db_utils init_db |
| 63 | +``` |
| 64 | +Autres commandes : |
| 65 | +``` |
| 66 | +# Réinitialiser la bdd |
| 67 | +PYTHONPATH=src python -m src.database.db_utils reset_db |
| 68 | +# Ajouter des données de tests |
| 69 | +PYTHONPATH=src python -m src.database.db_utils seed_db |
| 70 | +``` |
| 71 | +--- |
| 72 | + |
| 73 | +## 🧪 6. Vérifier la connexion à la base de données |
| 74 | +Lance les tests Pytest : |
| 75 | +``` |
| 76 | +PYTHONPATH=src pytest -v |
| 77 | +``` |
| 78 | + |
| 79 | +Si tout est bon, tu verras ✅ : |
| 80 | +tests/test_db.py::test_database_connection PASSED |
| 81 | + |
| 82 | +--- |
| 83 | + |
| 84 | +## 🤖 7. Lancer le bot |
| 85 | +Exécuter le bot : |
| 86 | +``` |
| 87 | +python src/main.py |
| 88 | +``` |
| 89 | + |
| 90 | +--- |
| 91 | + |
| 92 | +## 🧰 8. Développement et Qualité de code |
| 93 | +Formatage automatique : black |
| 94 | +Vérification de style : flake8 |
| 95 | + |
| 96 | +Exécution automatique avant chaque commit : |
| 97 | + |
| 98 | +Le hook pre-commit est déjà configuré. |
| 99 | +Il formate et vérifie ton code avant d’accepter le commit : |
| 100 | +``` |
| 101 | +pre-commit run --all-files |
| 102 | +``` |
| 103 | + |
| 104 | +--- |
| 105 | + |
| 106 | +## 🧠 Structure du projet |
| 107 | +``` |
| 108 | +WorldBoss/ |
| 109 | +│ |
| 110 | +├── .github/workflows/ # CI/CD |
| 111 | +├── .worldboss_data/ # Dossier de sauvegarde |
| 112 | +├── src/ |
| 113 | +│ ├── bot/ # Code du bot Discord |
| 114 | +│ ├── database/ # ORM + connexions SQLAlchemy |
| 115 | +│ ├── templates/ # Modèle pour les messages, button, etc. |
| 116 | +│ ├── config.py # Configuration centralisée |
| 117 | +│ └── main.py # Point d'entrée du projet |
| 118 | +│ |
| 119 | +├── tests/ # Tests unitaires pytest |
| 120 | +│ |
| 121 | +├── .env.example # Exemple de variables d'environnement |
| 122 | +├── requirements.txt |
| 123 | +├── INSTALL.md # Ce guide ! |
| 124 | +└── README.md # Présentation du projet |
| 125 | +``` |
| 126 | +--- |
| 127 | + |
| 128 | +## ✅ Vérification rapide |
| 129 | +| Commande | Action | |
| 130 | +| ---------------------------- | -------------------- | |
| 131 | +| `python src/main.py` | Lance le bot | |
| 132 | +| `pytest -v` | Exécute les tests | |
| 133 | +| `black .` | Formatte le code | |
| 134 | +| `flake8` | Vérifie le style | |
| 135 | +| `pre-commit run --all-files` | Teste tous les hooks | |
0 commit comments