diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 175 |
1 files changed, 120 insertions, 55 deletions
@@ -1,127 +1,192 @@ # celcatsanitizer -celcatsanitizer est un système qui permet de récupérer des emplois du temps Celcat au format XML pour les afficher correctement. +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 les emplois du temps Celcat sont peu lisibles et peuvent facilement faire planter un navigateur, à cause du surplus d’informations affichées. +Parce que les emplois du temps Celcat sont peu lisibles et peuvent +facilement faire planter un navigateur, à cause du surplus +d’informations affichées. ## Comment faire tourner celcatsanitizer chez moi ? -celcatsanitizer est écrit en Python 3. Il dépend des bibliothèques suivantes : - * Django 1.11 - * requests - * BeautifulSoup4 - * icalendar - -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. +celcatsanitizer est écrit en Python 3. Il dépend des bibliothèques +suivantes : + * [Django 1.11](https://www.djangoproject.com/) + * [requests](http://docs.python-requests.org/en/master/) + * [BeautifulSoup4](https://www.crummy.com/software/BeautifulSoup/bs4/doc/) + * [icalendar](https://icalendar.readthedocs.io/en/latest/) + +Pour installer celcatsanitizer, il est possible d’utiliser +[git](https://git-scm.com/). + +Pour tester celcatsanitizer, il est recommandé d’utiliser +[SQLite](https://www.sqlite.org/) ou +[PostgreSQL](https://www.postgresql.org/?&). + +Pour la production, il est recommandé d’utiliser PostgreSQL (avec le +driver +[psycopg2](http://initd.org/psycopg/docs/install.html#binary-install-from-pypi)) +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. +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 : +Déplacez-vous dans le répertoire souhaité, installez l’environnement +virtuel, et activez-le : -> $ virtualenv -p python3 celcatsanitizer +```bash +$ virtualenv -p python3 celcatsanitizer +$ cd celcatsanitizer +$ source bin/activate +``` -> $ cd celcatsanitizer +Il est possible que votre version de pip soit ancienne. Si vous le +souhaitez, mettez ce programme à jour : -> $ 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 +```bash +$ pip install --upgrade pip +``` #### Installation des dépendances -> $ pip install requests django beautifulsoup4 icalendar +```bash +$ pip install requests django beautifulsoup4 icalendar +``` -Si vous utilisez PostgreSQL, vous allez avoir besoin du driver psycopg2 : +Si vous utilisez PostgreSQL, vous allez avoir besoin du driver +psycopg2 : -> $ pip install psycopg2 +```bash +$ pip install psycopg2 +``` SQLite n’a pas besoin de driver. #### Création du répertoire Django -> $ django-admin startproject celcatsanitizer - -> $ cd celcatsanitizer +```bash +$ django-admin startproject celcatsanitizer +$ cd celcatsanitizer +``` #### Récupération des sources de celcatsanitizer -> $ git clone https://git.pa1ch.fr/alban/celcatsanitizer.git edt +```bash +$ 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. +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. +Dans le fichier celcatsanitizer/settings.py, vous devrez renseigner +plusieurs informations. ##### 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) +[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/) +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) +[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. +Si jamais vous utiliser Django en production, vous **devez** mettre la +variable DEBUG à False. ##### Ajout de celcatsanitizer dans la liste des applications Django -Ajoutez la chaine de caractère « edt » à la fin de la liste INSTALLED_APPS. +Ajoutez la chaine de caractère « edt » à la fin de la liste +INSTALLED_APPS. ##### Configuration des flatpages -celcatsanitizer utilise les flatpages pour rendre les pages « contact » et « à propos ». Vous pouvez retrouver le guide d’installation sur [le site de Django](https://docs.djangoproject.com/fr/1.11/ref/contrib/flatpages/#installation). Effectuez uniquement les deux premières étapes, celcatsanitizer enregistre déjà une route pour les pages statiques, et la commande de l’étape 4 sera effectuée plus loin. +celcatsanitizer utilise les flatpages pour rendre les pages +« contact » et « à propos ». Vous pouvez retrouver le guide +d’installation sur [le site de +Django](https://docs.djangoproject.com/fr/1.11/ref/contrib/flatpages/#installation). Effectuez +uniquement les deux premières étapes, celcatsanitizer enregistre déjà +une route pour les pages statiques, et la commande de l’étape 4 sera +effectuée plus loin. ##### Ajout du processeur de contexte de celcatsanitizer Cette étape est fortement recommandée, mais pas obligatoire. -Rajoutez la chaine de caractères 'edt.views.ctx_processor' à la liste 'context_processors' dans la variable « TEMPLATES ». +Rajoutez la chaine de caractères 'edt.views.ctx_processor' à la liste +'context_processors' dans la variable « TEMPLATES ». ##### 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. +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 Générer les migrations de celcatsanitizer, puis appliquez-les : -> $ ./manage.py makemigrations edt - -> $ ./manage.py migrate +```bash +$ ./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 : +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 +```bash +$ ./manage.py collectstatic +``` Cette étape est inutile si vous êtes en mode de déboguage. ### Lancement de celcatsanitizer -Si vous êtes en mode de déboguage, lancez le serveur de cette manière : +Si vous êtes en mode de déboguage, lancez le serveur de cette +manière : -> $ ./manage.py runserver +```bash +$ ./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. +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. ### Configuration de celcatsanitizer #### Administrateur -Pour avoir accès à l’interface d’administration, vous devez créer un utilisateur avec les droits administrateur. Pour cela, exécutez la commande suivante : +Pour avoir accès à l’interface d’administration, vous devez créer un +utilisateur avec les droits administrateur. Pour cela, exécutez la +commande suivante : -> $ ./manage.py createsuperuser +```bash +$ ./manage.py createsuperuser +``` -Renseignez ensuite votre nom d’utilisateur, mot de passe et adresse email au fur et à mesure. +Renseignez ensuite votre nom d’utilisateur, mot de passe et adresse +email au fur et à mesure. #### Pages statiques -Comme indiqué plus haut, celcatsanitizer utilise l’application flatpages de Django. +Comme indiqué plus haut, celcatsanitizer utilise l’application +flatpages de Django. -Si vous êtes en production, vous devez changer le site de base (« example.com ») par le site de celcatsanitizer. +Si vous êtes en production, vous devez changer le site de base +(« example.com ») par le site de celcatsanitizer. Vous devez ensuite rajouter les pages /a-propos/ et /contact/. -Vous pouvez effectuer tout ça à partir de l’interface d’administration de Django. +Vous pouvez effectuer tout ça à partir de l’interface d’administration +de Django. |