UniSquat_Python/README.md

78 lines
2.4 KiB
Markdown

# UniSquat
Application pour trouver rapidement les salles disponibles dans l'Université de Strasbourg.
C'est utile aux élèves qui cherchent un coin pour travailler ou manger, comme aux enseignants en détresse à cause d'un changement de salle imprévu.
Cette application dispose d'une interface Web fonctionnant avec Flask ( [voir la demo][homepage] ).
## Fonctionnalités
- 🔎 Visualiser les salles libres de plusieurs départements en même temps ( par exemple UFR de Math-Info et EOST )
- ⏰ Pour les salles bientôt occupées, l'heure d'occupation est précisée
- 🔄 Affiche également les salles qui sont bientôt libres, avec l'heure en question
- ⭐ Permet de sélectionner des salles comme favorites
* Ces favoris ne sont conservés que sur la page en question ( les favoris sélectionnés sont stockés dans l'URL )
* Ainsi, vous pouvez partager vos favoris simplement en partageant l'URL
* Encore en développement
## Dépendances
Pour l'instant, ce programme utilise les modules suivants :
- datetime
- icalendar
- requests
Pour la version Web (avec Flask) :
- flask
Vous pouvez aussi installer directement les dépendances avec `pip` :
```python
pip install -r requirements.txt
```
## Comment lancer la version web/Flask
Dans la racine du dossier :
```python
flask run
```
C'est la version la plus utilisable, n'hésitez pas à héberger votre propre version.
## Version antérieures
Ces versions sont plus anciennes, rudimentaires, et ne sont pas prévues pour être utilisables.
### Interface en ligne de commande
Un interface en ligne de commande est disponible. Elle ne nécessite pas de dépendances supplémentaires.
Pour le lancer :
```python
python main_cli.py
```
### Interface Qt5
Interface graphique utilisant la bibliothèque Qt. Elle nécessite le module `PyQt5`.
Pour le lancer :
```python
python main_gui.py
```
## Crédits
Le code est sous licence [GPLv3](https://choosealicense.com/licenses/gpl-3.0/).
UniSquat est créé par deux étudiants de l'université, plus d'information sur [notre site][homepage].
Notre travail est fait bénévolement, mais si vous voulez nous soutenir, passez au campus d'esplanade nous offrir un chocolat chaud ❤
Vous pouvez nous contacter sur nos comptes gitea respectifs, ou vous pouvez aller voir sur le [blog de @ayte](https://webair.xyz/fr/contact) pour plus d'options.
[homepage]: https://unisquat.alwaysdata.net