Skip to content

Commit

Permalink
French version of previous documentation for *features*
Browse files Browse the repository at this point in the history
  • Loading branch information
petersilva committed Aug 7, 2023
1 parent 77d859e commit 5ad6f16
Show file tree
Hide file tree
Showing 3 changed files with 124 additions and 10 deletions.
19 changes: 17 additions & 2 deletions docs/source/fr/Contribution/Développement.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1500,11 +1500,26 @@ Création d’un programme d’installation Windows
On peut également construire un programme d’installation Windows avec cela
`script <https://github.com/MetPX/sarracenia/blob/main/generate-win-installer.sh>`_.
Il doit être exécuté à partir d’un système d’exploitation Linux (de préférence Ubuntu 18)
dans le répertoire racine de git de Sarracenia. Ensuite, à partir du shell, exécutez ::
dans le répertoire racine de git de Sarracenia.

déterminer la version de python::

fractal% python -V
Python 3.10.12
fractal%


C'est donc python 3.10. Une seule version mineure aura le package intégré nécessaire
par pynsist pour construire l'exécutable. On valide chez::

https://www.python.org/downloads/windows/

afin to confirmer que la version avec un binaire *embedded* pour 3.10 et le 3.10.11
Ensuite, à partir du shell, exécutez ::

sudo apt install nsis
pip3 install pynsist wheel
./generate-win-installer.sh 2>&1 > log.txt
./generate-win-installer.sh 3.10.11 2>&1 > log.txt

Le paquet final doit être placé dans le répertoire build/nsis.

Expand Down
67 changes: 64 additions & 3 deletions docs/source/fr/Explication/SarraPluginDev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,6 @@ Il existe d’autres façons d’étendre Sarracenia v3 en sous-classant :

Cela sera discuté après que les rappels auront été traités.

Introduction
------------

Une pompe de données Sarracenia est un serveur Web avec des notifications pour les abonnés à
savoir, rapidement, quand de nouvelles données sont arrivées. Pour savoir quelles données sont déjà
disponible sur une pompe, visualisez l’arbre avec un navigateur web. Pour de besoins simple et immédiats,
Expand Down Expand Up @@ -850,6 +847,70 @@ les routines after_accept acceptent une liste de travail comme argument.
avec une instruction afin d’agir uniquement sur le message de première partie
pour les fichiers longs.



Le Dépendance Python dans les Callbacks
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Some callbacks need to use other python modules. While normal imports
are fine, one can integrate them better for sr3 users by supporting
the *features* mechism

Certains *callback* doivent utiliser d'autres modules Python. Alors que les
importations normales sont bien, on peut mieux les intégrer pour les
utilisateurs sr3 en prenant en se servant du mécanisme *features* ::

from sarracenia.featuredetection import features
#
# Support for features inventory mechanism.
#
features['clamd'] = { 'modules_needed': [ 'pyclamd' ], 'Needed': True,
'lament' : 'cannot use clamd to av scan files transferred',
'rejoice' : 'can use clamd to av scan files transferred' }

try:
import pyclamd
features['clamd']['present'] = True
except:
features['clamd']['present'] = False

This lets users know which *features* are available in their installetion
so when they run *sr3 features* it provides an easily understood list of missing
libraries


Cela permet aux utilisateurs de savoir quelles *features* sont disponibles dans leur installation.
Lorsqu'ils exécutent *sr3 features*, sr3 fournit une liste facile à comprendre des éléments manquants::

fractal% sr3 features
2023-08-07 13:18:09,219 1993037 [INFO] sarracenia.flow loadCallbacks flowCallback plugins to load: ['sarracenia.flowcb.retry.Retry', 'sarracenia.flowcb.housekeeping.resources.Resources', 'dcpflow', 'log', 'post.message', 'clamav']
2023-08-07 13:18:09,224 1993037 [INFO] dcpflow __init__ really I mean hi
2023-08-07 13:18:09,224 1993037 [WARNING] sarracenia.config add_option multiple declarations of lrgs_download_redundancy=['Yes', 'on'] choosing last one: on
2023-08-07 13:18:09,225 1993037 [INFO] dcpflow __init__ lrgs_download_redundancy is True
2023-08-07 13:18:09,225 1993037 [INFO] sarracenia.flowcb.log __init__ flow initialized with: {'post', 'on_housekeeping', 'after_work', 'after_accept', 'after_post'}
2023-08-07 13:18:09,226 1993037 [CRITICAL] sarracenia.flow loadCallbacks flowCallback plugin clamav did not load: 'pyclamd'

Status: feature: python imports: Description:
Installed amqp amqp can connect to rabbitmq brokers
Installed appdirs appdirs place configuration and state files appropriately for platform (windows/mac/linux)
Installed filetypes magic able to set content headers
Installed ftppoll dateparser,pytz able to poll with ftp
Installed humanize humanize humans numbers that are easier to read.
Absent mqtt paho.mqtt.client cannot connect to mqtt brokers
Installed redis redis,redis_lock can use redis implementations of retry and nodupe
Installed sftp paramiko can use sftp or ssh based services
Installed vip netifaces able to use the vip option for high availability clustering
Installed watch watchdog watch directories
Installed xattr xattr on linux, will store file metadata in extended attributes
MISSING clamd pyclamd cannot use clamd to av scan files transferred

state dir: /home/peter/.cache/sr3
config dir: /home/peter/.config/sr3

On peut voir que le module Python *pyclamed* nécessary pour que le *callback* fonctionne n´est pas
installé.


Idées d’extension
-----------------

Expand Down
48 changes: 43 additions & 5 deletions docs/source/fr/Tutoriel/Installer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,36 @@ Pour une utilisation opérationnelle, un accès administratif peut être nécess
et l’intégration avec systemd. Quelle que soit la façon dont il est installé, du traitement
périodique (sur Linux généralement connu sous le nom de *cron jobs*) peut également avoir besoin d’être configuré.

Des fois, Sarracenia peut être partiellement installé. Pour voir un inventaire des modules de Sarracenia
qui sont disponible, on peut se servir de *sr3 features*::

fractal% sr3 features

Status: feature: python imports: Description:
Installed amqp amqp can connect to rabbitmq brokers
Installed appdirs appdirs place configuration and state files appropriately for platform (windows/mac/linux)
Installed filetypes magic able to set content headers
Installed ftppoll dateparser,pytz able to poll with ftp
Installed humanize humanize humans numbers that are easier to read.
Absent mqtt paho.mqtt.client cannot connect to mqtt brokers
Installed redis redis,redis_lock can use redis implementations of retry and nodupe
Installed sftp paramiko can use sftp or ssh based services
Installed vip netifaces able to use the vip option for high availability clustering
Installed watch watchdog watch directories
Installed xattr xattr on linux, will store file metadata in extended attributes
MISSING clamd pyclamd cannot use clamd to av scan files transferred

state dir: /home/peter/.cache/sr3
config dir: /home/peter/.config/sr3

fractal%

le sens de chaque *feature* est expliqué (en anglais) et le modules python nécessaire pour
permettre cette fonctionalité sont indiqué dans la troisième colonne.

Dans l´exemple on peut voir que pyclamd manque à l´appel, tandis que *paramiko* nécessaire
pour la fonctionallité SFTP est disponible.

Installation Client
-------------------

Expand All @@ -40,6 +70,13 @@ référentiel launchpad. Si vous ne pouvez pas utiliser les paquets Debian, envi
avialable de PyPI. Dans les deux cas, les autres paquets python (ou dépendances) nécessaires
seront installé automatiquement par le gestionnaire de paquets.

Notez que dans certains cas, le système d'exploitation ne fournit pas tous les
fonctionnalité pour toutes les fonctionnalités, de sorte que l'on peut compléter avec des packages pip, qui
peut être installé à l'échelle du système, dans l'environnement d'un utilisateur ou même dans
venv. Tant que *sr3 features* signale la fonctionnalité comme disponible, elle
être utilisé.



Ubuntu/Debian (apt/dpkg) **Recommandé**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -51,6 +88,7 @@ Sur Ubuntu 22.04 et dérivés du même::
sudo apt install metpx-sr3 # pacquet principale.
sudo apt install metpx-sr3c # client binaire (en C) .
sudo apt install python3-amqp # support optionnel pour les courtiers AMWP (rabbitmq)
sudo apt install python3-paramiko # support optionnel pour SFTP/SSH
sudo apt install python3-magic # support optionnel pour les entêtes "content-type" dans les messages
sudo apt install python3-paho-mqtt # support optionnel pour les courtiers MQTT
sudo apt install python3-netifaces # support optionnel pour les vip (haut-disponibilité)
Expand Down Expand Up @@ -123,14 +161,14 @@ Par exemple, sur fedora 28 obligatoirement::
$ sudo dnf install python3-humanize
$ sudo dnf install python3-psutil
$ sudo dnf install python3-watchdog
$ sudo dnf install python3-paramiko

Facultatifs::

$ sudo dnf install python3-amqp # optionally support rabbitmq brokers
$ sudo dnf install python3-magic # optionally support content-type headers in files.
$ sudo dnf install python3-netifaces # optionally support vip directive for HA.
$ sudo dnf install python3-paho-mqtt # optionally support mqtt brokers
$ sudo dnf install python3-paramiko # support pour SFTP/SSH
$ sudo dnf install python3-amqp # support pour les messages AMQP (couriers rabbitmq)
$ sudo dnf install python3-magic # support optionnel pour le champs ¨content-type¨
$ sudo dnf install python3-netifaces # support optionnel pour l´optio vip
$ sudo dnf install python3-paho-mqtt # support optionnel pour les courtiers MQTT

$ sudo dnf install python3-setuptools # needed to build rpm package.

Expand Down

0 comments on commit 5ad6f16

Please sign in to comment.