noham/PronoteBot
1
0
Fork 0
mirror of https://github.com/NohamR/PronoteBot.git synced 2025-05-24 00:49:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
√(noham)² 2024-01-25 22:24:23 +01:00 committed by GitHub
parent a3c50e151c
commit 100daa6bdf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,6 +1,6 @@
# PronoteApi # PronoteBot
PronoteApi est un projet conçu pour faciliter la récupération des notes Pronote et envoyer des mises à jour à un webhook. Il utilise la bibliothèque [pronotepy](https://github.com/bain3/pronotepy) pour les interactions avec Pronote. PronoteBot est un projet conçu pour faciliter la récupération des notes Pronote et envoyer des mises à jour à un webhook. Il utilise la bibliothèque [pronotepy](https://github.com/bain3/pronotepy) pour les interactions avec Pronote.
## Dépendances ## Dépendances
@ -10,13 +10,13 @@ PronoteApi est un projet conçu pour faciliter la récupération des notes Prono
## Utilisation ## Utilisation
Pour utiliser PronoteApi, suivez ces étapes : Pour utiliser PronoteBot, suivez ces étapes :
1. Clonez le dépôt : 1. Clonez le dépôt :
```bash ```bash
git clone https://github.com/NohamR/PronoteApi.git git clone https://github.com/NohamR/PronoteBot.git
cd PronoteApi cd PronoteBot
``` ```
2. Installez les dépendances : 2. Installez les dépendances :
@ -37,7 +37,7 @@ Pour utiliser PronoteApi, suivez ces étapes :
Pour avoir le nom de votre ent : [ici](https://pronotepy.readthedocs.io/en/stable/api/ent.html), par exemple : ile_de_france. Pour avoir le nom de votre ent : [ici](https://pronotepy.readthedocs.io/en/stable/api/ent.html), par exemple : ile_de_france.
4. Exécutez le script PronoteApi : 4. Exécutez le script PronoteBot :
```bash ```bash
python3 getgrades.py python3 getgrades.py
@ -46,19 +46,19 @@ Pour avoir le nom de votre ent : [ici](https://pronotepy.readthedocs.io/en/stabl
## Docker ## Docker
Vous pouvez également construire et exécuter PronoteApi en tant que conteneur Docker. Utilisez les configurations Dockerfile et docker-compose.yaml suivantes : Vous pouvez également construire et exécuter PronoteBot en tant que conteneur Docker. Utilisez les configurations Dockerfile et docker-compose.yaml suivantes :
### Dockerfile ### Dockerfile
Le fichier Dockerfile est disponible [ici](Dockerfile). Assurez-vous de le placer à la racine du répertoire PronoteApi. Le fichier Dockerfile est disponible [ici](Dockerfile). Assurez-vous de le placer à la racine du répertoire PronoteBot.
Pour construire l'image Docker, exécutez la commande suivante à la racine du répertoire PronoteApi : Pour construire l'image Docker, exécutez la commande suivante à la racine du répertoire PronoteBot :
docker build -t pronoteapi:latest . docker build -t PronoteBot:latest .
docker run -d pronoteapi:latest docker run -d PronoteBot:latest
### docker-compose.yaml ### docker-compose.yaml
Le fichier docker-compose.yaml est disponible [ici](docker-compose.yaml). Assurez-vous de le placer à la racine du répertoire PronoteApi. Le fichier docker-compose.yaml est disponible [ici](docker-compose.yaml). Assurez-vous de le placer à la racine du répertoire PronoteBot.
docker-compose up -d docker-compose up -d