From b5b2c5ffa37d9d6aa6871f7ea74f4f25363cf46f Mon Sep 17 00:00:00 2001
From: Bastien Le Querrec <blq@laquadrature.net>
Date: Mon, 15 Apr 2024 00:33:45 +0200
Subject: [PATCH] README: ajoute des informations sur les options

---
 README.md | 22 ++++++++++++++++++++++
 cli.py    |  2 +-
 2 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3a9587c..840bddb 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,28 @@ Attention, le premier lancement prendra plusieurs jours ! Si vous utilisez une C
 
 Il est possible de ne lancer l'analyse que pour une seule administration, avec la commande : `./cli.py identifiant`
 
+## Options
+
+Les options suivantes peuvent être précisées, par un paramètre si l'utilitaire `cli.py` est utilisé, ou par une variable d'environnement :
+
+| CLI | Variable d'environnement | Signification | Valeur par défaut |
+|---|---|---|---|
+| `--keywords`, `-k` | `KEYWORDS` | Liste des mots-clés recherchés, séparés par une virgule. | Aucune |
+| `--not-before` | `NOT_BEFORE` | Date (format YYYY-MM-DD) avant laquelle les RAA ne sont pas analysés. | `2024-01-01` |
+| `--smtp-hostname` | `SMTP_HOSTNAME` | Nom d'hôte SMTP. | `localhost` |
+| `--smtp-username` | `SMTP_USERNAME` | Nom d'utilisateur SMTP. | Aucun |
+| `--smtp-password` | `SMTP_PASSWORD` | Mot de passe SMTP. | Aucun |
+| `--smtp-port` | `SMTP_PORT` | Port SMTP. | `587` |
+| `--smtp-starttls` | `SMTP_STARTTLS` | Si spécifié, la connexion SMTP se fait avec STARTTLS. | Non-spécifié |
+| `--smtp-ssl` | `SMTP_SSL` | Si spécifié, la connexion SMTP se fait avec SSL. | Non-spécifié |
+| `--email-from`, `-f` | `EMAIL_FROM` | Adresse de courrier électronique expéditrice des notifications. | Aucune (désactive l'envoi) |
+| `--email-to`, `-t` | `EMAIL_TO` | Adresses de courriers électroniques destinataires des notifications, séparées par une virgule. | Aucune (désactive l'envoi) |
+| `--**-email-to` | `--**-EMAIL-TO` | Pour chaque administration dont l'identifiant est **, adresses de courriers électroniques destinataires des notifications, séparées par une virgule, uniquement si l'analyse concerne cette administration en particulier. La liste s'ajoute à celle précisée dans `--email-to`. | Aucune |
+| `--mastodon-access-token` | `MASTODON_ACCESS_TOKEN` | Jeton d'accès pour publier sur Mastodon. | Aucun (désactive la publication sur Mastodon) |
+| `--mastodon-instance` | `MASTODON_INSTANCE` | URL de l'instance Mastodon de publication (doit inclure "http://" ou "https://"). | Aucune (désactive la publication sur Mastodon) |
+| `-v` | `VERBOSE` | Si spécifié, relève le niveau de verbosité à INFO. | Non-spécifié |
+| `-vv` | `VVERBOSE` | Si spécifié, relève le niveau de verbosité à DEBUG. | Non-spécifié |
+
 ## Administrations supportées
 
 - Préfecture de police de Paris (identifiant : `ppparis`)
diff --git a/cli.py b/cli.py
index a2c3315..ffc4240 100755
--- a/cli.py
+++ b/cli.py
@@ -125,7 +125,7 @@ parser.add_argument(
     '-t',
     '--email-to',
     action='store',
-    help='adresses de courrier électronique destinataires des notifications (séparées par une virgule)'
+    help='adresses de courriers électroniques destinataires des notifications (séparées par une virgule)'
 )
 
 for administration in available_administrations:
-- 
GitLab