diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 66 |
1 files changed, 41 insertions, 25 deletions
@@ -6,16 +6,16 @@ Parce que les emplois du temps Celcat sont peu lisibles et peuvent facilement fa ## 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 + - [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. +Pour installer celcatsanitizer, il est possible d’utiliser [git](https://git-scm.com/). -Pour tester celcatsanitizer, il est recommandé d’utiliser SQLite ou PostgreSQL. +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) et de mettre le tout dans un environnement virtuel. +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. @@ -25,35 +25,44 @@ Il est préférable d’utiliser un environnement virtuel, mais ce n’est pas o #### 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 +```bash +$ 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 +```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 : -> $ 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. @@ -91,21 +100,26 @@ Dans le fichier celcatsanitizer/urls.py, importez la fonction django.conf.urls.i ##### 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 : -> $ ./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 : -> $ ./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. @@ -113,7 +127,9 @@ Si vous êtes en production, il n’est pas recommandé d’utiliser ce serveur. #### 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 : -> $ ./manage.py createsuperuser +```bash +$ ./manage.py createsuperuser +``` Renseignez ensuite votre nom d’utilisateur, mot de passe et adresse email au fur et à mesure. |