UniSquat_Python/README.md

# UniSquat

Une 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. Une version en ligne est disponible [ici][homepage].

## Fonctionnalités

- 🔎 Visualiser les salles libres de plusieurs départements en même temps (par exemple : l'UFR de Math-Info et l'EOST).
- ⏰ Connaître la période de disponibilité d'une salle.
- 🔜 Les salles prochainement libres sont également affichées, avec leur prochaine disponibilité.
- ⭐ Marquer des salles comme favorites, pour les afficher en haut de la page.
  * Les favoris sont stockés dans l'URL de la page. Cela permet de les partager ou de les enregistrer simplement, puisqu'il suffit de partager l'URL ou de l'ajouter aux marque-pages.
* 📅 Rechercher les salles libres à une date précise.
- 🪶 Application légère pour l'utilisateur :
  * Pas de JavaScript, tous les calculs sont fait coté serveur
  * Pas de *Local Storage*, *cookies* ou autres *bibliothèques CSS*

## Dépendances

Le modules Python suivant sont requis (ils peuvent être installés avec `pip`) :

- `datetime`
- `icalendar`
- `requests`
- `flask` (requis pour l'interface Web)

Vous pouvez aussi installer directement les dépendances avec cette commande :

```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.

## Interfaces obsolètes

Ces interfaces ont été crées à des fins de test. Elles peuvent être instables, et ne sont plus mises à jour.

### Interface en ligne de commande

Une interface en ligne de commande est disponible. Elle ne nécessite pas de dépendances supplémentaires.

Pour la lancer :

```python
python main_cli.py
```

### Interface Qt5

Une interface graphique utilisant la bibliothèque Qt. Elle nécessite le module `PyQt5`.

Pour la 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é de Strasbourg. Rendez-vous sur [la page d'accueil d'UniSquat][homepage] pour plus d'informations.

Notre travail est fait de façon bénévole, mais si vous souhaitez nous soutenir, n'hésitez pas à passer sur le campus de l'Esplanade pour nous offrir un chocolat chaud ❤

Vous pouvez nous contacter sur nos comptes Git respectifs. Vous pouvez aussi contacter @ayte [sur son blog](https://webair.xyz/fr/contact).

[homepage]: https://unisquat.alwaysdata.net