1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
# celcatsanitizer
celcatsanitizer est un système qui permet de récupérer des emplois du temps Celcat au format XML pour les afficher correctement.
## Pourquoi ?
Parce que j'en avait ma claque de consulter un emploi du temps mal formaté. Parce que j'en avait ma claque de voir mon Firefox se figer pour pouvoir vérifier mes horaires de la journée. Parce que j'en avait ma claque d'avoir de devoir retrouver une pépite d'information dans un océan de texte. (et parce que j'avais un peu trop de temps libre aussi)
## Comment faire tourner celcatsanitizer chez moi ?
celcatsanitizer est écrit en Python 3. Il dépend des bibliothèques suivantes :
* Django 1.11
* requests
* BeautifulSoup4
Pour installer celcatsanitizer, il est possible d'utiliser git.
Pour tester celcatsanitizer, il est recommandé d'utiliser SQLite ou PostgreSQL.
Pour la production, il est recommandé d'utiliser PostgreSQL (avec le driver psycopg2) et de mettre le tout dans un environnement virtuel.
Aucun autre SGBD n'a été testé, mais depuis la version 0.8.0, celcatsanitizer n'utilise plus de fonctions SQL brutes spécifiques. Tous les SGBD supportés par Django devraient fonctionner sans poser de problèmes.
### Installation
Il est préférable d'utiliser un environnement virtuel, mais ce n'est pas obligatoire. Si vous ne souhaitez pas utiliser un environnement virtuel, passez directement à l'installation des dépendances.
#### Création de l'environnement virtuel
Déplacez-vous dans le répertoire souhaité, installez l'environnement virtuel, et activez-le :
> $ virtualenv -p python3 celcatsanitizer
> $ cd celcatsanitizer
> $ source bin/activate
Il est possible que votre version de pip soit ancienne. Si vous le souhaitez, mettez ce programme à jour :
> $ pip install --upgrade pip
Notez que cette étape n'est pas obligatoire
#### Installation des dépendances
> $ pip install requests
> $ pip install django
> $ pip install beautiful4
Si vous utilisez PostgreSQL, vous allez avoir besoin du driver psycopg2 :
> $ pip install psycopg2
SQLite n'a pas besoin de driver.
#### Création du répertoire Django
> $ django-admin startproject celcatsanitizer
> $ cd celcatsanitizer
#### Récupération des sources de celcatsanitizer
> $ git clone https://git.pa1ch.fr/alban/celcatsanitizer.git edt
Pour la production, il est recommandé d'utiliser une version stable, accessibles à travers les tags git.
#### Configuration de Django
Dans le fichier celcatsanitizer/settings.py, vous devrez renseigner plusieurs informations.
##### Configuration du serveur mail
[Vous pouvez trouver la documentation concernant l'envoi des mails sur le site de Django.](https://docs.djangoproject.com/fr/1.11/topics/email/)
##### Configuration des administrateurs
[Vous pouvez retrouver la documentation de la variable ADMIN sur le site de Django.](https://docs.djangoproject.com/fr/1.11/ref/settings/#admins)
Cette variable est obligatoire.
##### Configuration de l'internationalisation
Ce passage n'est pas obligatoire. [Vous pouvez retrouver la documentation de l'internationalisation sur le site de Django.](https://docs.djangoproject.com/fr/1.11/topics/i18n/)
##### Configuration de la base de données
[Vous pouvez retrouver la documentation de la base de données sur le site de Django.](https://docs.djangoproject.com/fr/1.11/ref/settings/#databases)
##### Configuration du mode de Django
Si jamais vous utiliser Django en production, vous **devez** mettre la variable DEBUG à False.
##### Configuration personnalisée nécessaire à celcatsanitizer
celcatsanitizer a besoin d'une variable DEFAULT_DOMAIN qui contient l'URL de base de l'instance.
##### Ajout de celcatsanitizer dans la liste des applications Django
Ajoutez la chaine de caractère "edt" à la fin de la liste INSTALLED_APPS
##### Ajout des URLs de celcatsanitizer
Dans le fichier celcatsanitizer/urls.py, importez la fonction django.conf.urls.include, et ajoutez url(r'^', include("edt.urls")) à la **fin** de la liste urlspatterns.
##### Génération de la base de données
Vous avez besoin de générer les migrations de celcatsanitizer, puis appliquez-les :
> $ ./manage.py makemigrations edt
> $ ./manage.py migrate
##### Gestion des fichiers statiques
Si vous êtes en production, vous devez renseigner l'emplacement de vos fichiers statiques dans la variable [STATIC_ROOT](https://docs.djangoproject.com/fr/1.11/ref/settings/#std:setting-STATIC_ROOT) de la configuration de Django, puis exécuter la commande suivante :
> $ ./manage.py collectstatic
### Lancement de celcatsanitizer
Si vous êtes en mode de débuggage, lancez le serveur de cette manière :
> $ ./manage.py runserver
Si vous êtes en production, il n'est pas recommandé d'utiliser ce serveur. Exécutez Django avec le module mod_wsgi d'Apache, ou avec un serveur [gunicorn](http://gunicorn.org/) derrière nginx.
|
