aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlban Gruin2019-09-01 18:51:10 +0200
committerAlban Gruin2019-09-01 20:43:21 +0200
commita6eaecf48f63c37cf851386a45cd4b25ac3ed1e0 (patch)
tree670b2a78bfeb151096cfa844d6b48559dfc3641b
parent88fcd3f9d66713292fb8167ef58c7fa2455f3e8c (diff)
doc: mise à jour de la doc pour la future version 0.16futur
Signed-off-by: Alban Gruin <alban at pa1ch dot fr>
-rw-r--r--Documentation/dev/roadmap.rst6
-rw-r--r--Documentation/usage/installation.rst25
-rw-r--r--Documentation/usage/versions.rst32
3 files changed, 46 insertions, 17 deletions
diff --git a/Documentation/dev/roadmap.rst b/Documentation/dev/roadmap.rst
index 14cad2a..1ae17af 100644
--- a/Documentation/dev/roadmap.rst
+++ b/Documentation/dev/roadmap.rst
@@ -2,14 +2,12 @@
Feuille de route
================
-.. _ref-ver-0.15:
+.. _ref-ver-0.16:
-Version 0.15
+Version 0.16
============
- Optimisation des requêtes en utilisant des fonctionnalités
spécifiques à PostgreSQL si nécessaire
- - Utilisation de Django 2.1 et de l’aggrégat ``TruncWeek``.
- - Amélioration du parseur UPS2018 et de sa documentation.
- Remplacement du moteur de templates de Django par Jinja2_ ?
- Améliorations de certaines pages ?
diff --git a/Documentation/usage/installation.rst b/Documentation/usage/installation.rst
index 92b3c5d..b86b257 100644
--- a/Documentation/usage/installation.rst
+++ b/Documentation/usage/installation.rst
@@ -7,7 +7,7 @@ Dépendances
celcatsanitizer est écrit en Python 3. Il dépend des bibliothèques
suivantes :
- - `Django 2.0`_
+ - `Django 2.2`_
- requests_, pour récupérer les emplois du temps en HTTP(S)
- BeautifulSoup4_ et LXML_, pour parser les emplois du temps en XML
- icalendar_, pour générer des fichiers ICS_.
@@ -16,10 +16,9 @@ Une dépendance est optionnelle :
- `Django REST Framework`_, pour l’:doc:`API REST <rest>`.
-celcatsanitizer requiert Python 3.4 au minimum, et marche avec les
-versions 3.5 et 3.6. Les versions antérieures de Python 3 n’ont pas
-étés testées, et les versions supérieures devraient fonctionner sans
-problèmes.
+celcatsanitizer requiert Python 3.6 au minimum. Les versions
+supérieures devraient fonctionner sans problèmes, mais pas les
+versions antérieures.
*A priori*, il est possible d’utiliser n’importe quel SGBD supporté
par Django avec celcatsanitizer. Cependant, l’utilisation de
@@ -28,7 +27,7 @@ d’installer le module psycopg2_.
Pour l’instant, l’installation doit passer par git_.
-.. _Django 2.0: https://www.djangoproject.com/
+.. _Django 2.2: https://www.djangoproject.com/
.. _requests: http://docs.python-requests.org/en/master/
.. _BeautifulSoup4:
https://www.crummy.com/software/BeautifulSoup/bs4/doc/
@@ -46,12 +45,9 @@ celcatsanitizer utilise des versions assez récentes de Django,
notamment en ce qui concerne son ORM. Le passage de Django 1.10 à
Django 1.11 s’est fait pour utiliser l’annotation ``ExtractWeek``, le
passage de Django 1.11 à Django 2.0 pour utiliser l’attribut
-``distinct`` de l’aggrégat ``ArrayAgg``.
-
-celcatsanitizer passera à Django 2.1 lorsqu’il sortira pour utiliser
-l’annotation ``TruncWeek``, pour l’instant implémenté avec une requête
-SQL brute. Cette fonctionnalité ne sera nécessaire que pour les
-utilisateurs de PostgreSQL.
+``distinct`` de l’aggrégat ``ArrayAgg``. Il utilise l’aggrégat
+``TruncWeek`` apparu dans Django 2.1, et se base officiellement sur
+Django 2.2 pour bénéficier du support à long terme.
Installation
============
@@ -191,7 +187,7 @@ __
Sélection du parseur
````````````````````
celcatsanitizer dispose d’un système de parseurs modulaires depuis la
-:ref:`version 0.14 <ref-ver-0.14>`, et embarque par défaut deux
+:ref:`version 0.14 <ref-ver-0.14>`, et embarque par défaut trois
parseurs :
- ``edt.management.parsers.ups2017``, pour le format utilisé par
@@ -201,6 +197,9 @@ parseurs :
- ``edt.management.parsers.ups2018``, pour le format utilisé par
l’Université Paul Sabatier en 2018. Ce parseur utilise LXML_ et
exploite l’IO asynchrone de Python.
+ - ``edt.management.parsers.ups2019``, pour le format utilisé par
+ l’Université Paul Sabatier en 2019. Ce parseur utilise le module
+ JSON standard.
Pour spécifier le parseur à utiliser, il faut rajouter une variable
``CS_PARSER``, contenant le parseur à utiliser sous forme de chaîne de
diff --git a/Documentation/usage/versions.rst b/Documentation/usage/versions.rst
index ed76ce5..d4e6d1f 100644
--- a/Documentation/usage/versions.rst
+++ b/Documentation/usage/versions.rst
@@ -118,3 +118,35 @@ Version 0.14.4
--------------
- Ajout d’une liste de logiciels lisant les calendriers au format ICS
et déconseillant l’usage de Google Calendar.
+
+.. _ref-ver-0.15:
+
+Version 0.15
+============
+Changements externes
+--------------------
+ - Utilisation du nouveau nom de ICSdroid (maintenant ICSx⁵) dans la
+ page des calendriers.
+ - Copyright 2019.
+
+Changements internes
+--------------------
+ - Ajout de tests pour le parseur UPS2018.
+ - Ajout du parseur UPS2019.
+ - Ajout d’une table « modules ».
+ - Mise à jour de Python. La version minimale supportée est la 3.6.
+ - Mise à jour de Django et utilisation de TruncWeek.
+
+Autres remarques
+----------------
+Les objectifs originaux de celcatsanitizer consistaient en ceux de la
+:ref:`version 0.16 <ref-ver-0.16>`, à savoir :
+
+ - Optimisation des requêtes en utilisant des fonctionnalités
+ spécifiques à PostgreSQL si nécessaire
+ - Remplacement du moteur de templates de Django par Jinja2_.
+
+.. _Jinja2: http://jinja.pocoo.org/
+
+Ils n’ont pas pu être suivis à cause d’un manque de temps et de tests
+et ont étés reportés à la version 0.16.