Commit 872ad8de authored by erdnaxe's avatar erdnaxe 🎇

Better README

parent 20974d6c
...@@ -2,22 +2,80 @@ ...@@ -2,22 +2,80 @@
SaphSync permet de syncroniser son agenda SAPHIRE en : SaphSync permet de syncroniser son agenda SAPHIRE en :
* Enlevant les TP, TD et BE qui ne nous concerne pas ; * Enlevant les TP, TD et BE qui ne nous concerne pas ;
* Enlevant les évènements passés ; * Enlevant les évènements passés ;
* En fussionannt tout en un unique calendrier au format ICS. * En fussionannt tout en un unique calendrier au format ICS.
Il a été testé avec :
* Mozilla Thunderbird ;
* Gnome Calendar ;
* Google Calendar (web and Android) ;
* ICSx5 (Android).
## Mise en place ## Mise en place
### Installation des dépendances
SaphSync requiert quelques dépendances dont :
* Python 3 ;
* `keyring` pour gérer les trousseaux de clés ;
* `yaml` pour lire la configuration YAML ;
* `caldac` pour accèder au serveur caldav de l'ENS ;
* `icalendar` pour écrire facilement un fichier iCalendar.
### Configuration
Il faut créer `config.yml` à partir de `config.yml.example`. Il faut créer `config.yml` à partir de `config.yml.example`.
Dans ce fichier on défini le nom d'utilisateur ENS, ainsi que nos groupes de TD, TP ou BE.
Si on ne souhaite pas filtrer un cours, alors il faut supprimer ou commenter la ligne.
Ensuite il faut donner son mot de passe ENS dans son trousseau de clé. Ensuite il faut donner son mot de passe ENS dans son trousseau de clé système.
Pour cela : Pour cela, on peut le faire en Python de cette manière :
```Python ```Python
import keyring import keyring
keyring.set_password('sogo', 'identifiant', 'mon_de_passe') keyring.set_password('sogo', 'identifiant', 'mon_de_passe')
``` ```
Ou sinon utiliser une application tel que Gnome Keyring en nommant l'entrée ### Lancement
`sogo`.
Placez vous dans le dossier où vous avez cloné le code et lancer le script :
```bash
./saphsync.py
```
Un fichier `calendar.ics` va être écrit.
C'est ce fichier que vous voulez ensuite utiliser et intégrer dans vos différentes applications.
## Exemple d'intégration
### Intégration à Gnome Calendar
Il peut être sympathique d'avoir ses évènements directement dans ses notifications de bureau Gnome.
Pour cela ouvrez l'application *Gnome Calendar* et dans `Calendar Settings` ajouter un calendrier
à partir d'un fichier local.
À chaque fois que SaphSync sera exécuté, le calendrier Gnome sera automatiquement mis à jour.
### Intégration à Google Calendar
Pour mettre son calendrier dans Google Calendar il faut qu'il soit publique sur internet.
On va utiliser le serveur Zamok du Cr@ns.
Copier le fichier `icalendar.ics` vers votre page publique Zamok :
```bash
scp calendar.ics zamok.crans.org:~/www/
```
Votre calendrier est maintenant accessible à <https://perso.crans.org/pseudo/calendar.ics>.
Ouvrez maintenant les paramètres de Google Calendar Web
puis aller dans [Ajouter un calendrier à partir d'une URL](https://calendar.google.com/calendar/r/settings/addbyurl).
Voilà :)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment