From 3bc7644b850af6dd6a8bb54eee23ca524db1e54c Mon Sep 17 00:00:00 2001 From: Alban Gruin Date: Thu, 9 Feb 2017 21:40:59 +0100 Subject: Ajout d'un readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..acacf5a --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ += 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) -- cgit v1.2.1 From 9bf08b998dfaf58169886b83e48c0d3b7fd4248f Mon Sep 17 00:00:00 2001 From: Alban Gruin Date: Thu, 9 Feb 2017 21:41:46 +0100 Subject: Re-oups --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index acacf5a..a01cfec 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ -= celcatsanitizer - +# 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 ? +## 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) -- cgit v1.2.1 From 3a57caf3409d512dfd076deeb7ff4c9ea054f0e6 Mon Sep 17 00:00:00 2001 From: Alban Gruin Date: Thu, 9 Feb 2017 22:42:18 +0100 Subject: Début de documentation --- README.md | 101 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index a01cfec..d7f01c3 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,104 @@ celcatsanitizer est un système qui permet de récupérer des emplois du temps C ## 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.10 + * 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é aujourd'hui. Toute modification visant à faire fonctionner celcatsanitizer avec un autre SGBD sera bien entendu acceptée. + +### 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=="1.10.*" +> 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 : + +> cd edt +> git checkout v0.4.0 +> cd .. + +#### 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.10/topics/email/) + +Pour l'instant, la désactivation des mails n'est pas encore supporté. + +##### Configuration des administrateurs +[Vous pouvez retrouver la documentation de la variable ADMIN sur le site de Django.](https://docs.djangoproject.com/fr/1.10/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.10/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.10/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 + +### 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 le serveur gunicorn, derrière un serveur nginx. -- cgit v1.2.1 From b7cf872e3259de08afdbc994ebf259ae8cdf5617 Mon Sep 17 00:00:00 2001 From: Alban Gruin Date: Thu, 9 Feb 2017 22:44:08 +0100 Subject: Séparation des quotes --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index d7f01c3..694c0f3 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,9 @@ Il est préférable d'utiliser un environnement virtuel, mais ce n'est pas oblig 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 : @@ -37,7 +39,9 @@ Notez que cette étape n'est pas obligatoire #### Installation des dépendances > pip install requests + > pip install django=="1.10.*" + > pip install beautiful4 Si vous utilisez PostgreSQL, vous allez avoir besoin du driver psycopg2 : @@ -49,6 +53,7 @@ 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 @@ -58,7 +63,9 @@ SQLite n'a pas besoin de driver. Pour la production, il est recommandé d'utiliser une version stable, accessibles à travers les tags git : > cd edt + > git checkout v0.4.0 + > cd .. #### Configuration de Django @@ -96,6 +103,7 @@ Dans le fichier celcatsanitizer/urls.py, importez la fonction django.conf.urls.i Vous avez besoin de générer les migrations de celcatsanitizer, puis appliquez-les : > ./manage.py makemigrations edt + > ./manage.py migrate ### Lancement de celcatsanitizer -- cgit v1.2.1 From 48db9741a29f2a6b71b36e2fea38367a3e45e3a9 Mon Sep 17 00:00:00 2001 From: Alban Gruin Date: Thu, 9 Feb 2017 22:46:02 +0100 Subject: Ajout d'un symbole pour représenter le shell --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 694c0f3..055af7c 100644 --- a/README.md +++ b/README.md @@ -24,49 +24,49 @@ Il est préférable d'utiliser un environnement virtuel, mais ce n'est pas oblig #### 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 +> % virtualenv -p python3 celcatsanitizer -> cd celcatsanitizer +> % cd celcatsanitizer -> source bin/activate +> % 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 +> % pip install --upgrade pip Notez que cette étape n'est pas obligatoire #### Installation des dépendances -> pip install requests +> % pip install requests -> pip install django=="1.10.*" +> % pip install django=="1.10.*" -> pip install beautiful4 +> % pip install beautiful4 Si vous utilisez PostgreSQL, vous allez avoir besoin du driver psycopg2 : -> pip install psycopg2 +> % pip install psycopg2 SQLite n'a pas besoin de driver. #### Création du répertoire Django -> django-admin startproject celcatsanitizer +> % django-admin startproject celcatsanitizer -> cd celcatsanitizer +> % cd celcatsanitizer #### Récupération des sources de celcatsanitizer -> git clone https://git.pa1ch.fr/alban/celcatsanitizer.git edt +> % 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 : -> cd edt +> % cd edt -> git checkout v0.4.0 +> % git checkout v0.4.0 -> cd .. +> % cd .. #### Configuration de Django Dans le fichier celcatsanitizer/settings.py, vous devrez renseigner plusieurs informations. @@ -102,13 +102,13 @@ Dans le fichier celcatsanitizer/urls.py, importez la fonction django.conf.urls.i ##### 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 makemigrations edt -> ./manage.py migrate +> % ./manage.py migrate ### Lancement de celcatsanitizer Si vous êtes en mode de débuggage, lancez le serveur de cette manière : -> ./manage.py runserver +> % ./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 le serveur gunicorn, derrière un serveur nginx. -- cgit v1.2.1 From 04b0d6f081627df7809f1fbd2890d7e93aef12bb Mon Sep 17 00:00:00 2001 From: Alban Gruin Date: Thu, 9 Feb 2017 22:46:44 +0100 Subject: En fait le signe $ c'est mieux je crois --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 055af7c..afa2b35 100644 --- a/README.md +++ b/README.md @@ -24,49 +24,49 @@ Il est préférable d'utiliser un environnement virtuel, mais ce n'est pas oblig #### 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 +> $ virtualenv -p python3 celcatsanitizer -> % cd celcatsanitizer +> $ cd celcatsanitizer -> % source bin/activate +> $ 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 +> $ pip install --upgrade pip Notez que cette étape n'est pas obligatoire #### Installation des dépendances -> % pip install requests +> $ pip install requests -> % pip install django=="1.10.*" +> $ pip install django=="1.10.*" -> % pip install beautiful4 +> $ pip install beautiful4 Si vous utilisez PostgreSQL, vous allez avoir besoin du driver psycopg2 : -> % pip install psycopg2 +> $ pip install psycopg2 SQLite n'a pas besoin de driver. #### Création du répertoire Django -> % django-admin startproject celcatsanitizer +> $ django-admin startproject celcatsanitizer -> % cd celcatsanitizer +> $ cd celcatsanitizer #### Récupération des sources de celcatsanitizer -> % git clone https://git.pa1ch.fr/alban/celcatsanitizer.git edt +> $ 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 : -> % cd edt +> $ cd edt -> % git checkout v0.4.0 +> $ git checkout v0.4.0 -> % cd .. +> $ cd .. #### Configuration de Django Dans le fichier celcatsanitizer/settings.py, vous devrez renseigner plusieurs informations. @@ -102,13 +102,13 @@ Dans le fichier celcatsanitizer/urls.py, importez la fonction django.conf.urls.i ##### 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 makemigrations edt -> % ./manage.py migrate +> $ ./manage.py migrate ### Lancement de celcatsanitizer Si vous êtes en mode de débuggage, lancez le serveur de cette manière : -> % ./manage.py runserver +> $ ./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 le serveur gunicorn, derrière un serveur nginx. -- cgit v1.2.1