Skip to content

Commit

Permalink
updating english jupyter notebooks, also some french lint fixing
Browse files Browse the repository at this point in the history
  • Loading branch information
petersilva committed Jan 12, 2024
1 parent cd6cf0a commit 7235582
Show file tree
Hide file tree
Showing 19 changed files with 263 additions and 260 deletions.
227 changes: 116 additions & 111 deletions docs/source/Tutorials/1_CLI_introduction.ipynb

Large diffs are not rendered by default.

221 changes: 111 additions & 110 deletions docs/source/Tutorials/2_CLI_with_flowcb_demo.ipynb

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/source/Tutorials/3_api_flow_demo.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"source": [
"# flow API Example\n",
"\n",
"The [sarracenia.flow class](../Reference/code.html#module-sarracenia.flow) provides built in accept/reject filtering for messages, supports built-in downloading in several protocols, retries on failure, and allows the creation of callbacks, to customize processing.\n",
"The [sarracenia.flow class](../Reference/code.rst#module-sarracenia.flow) provides built in accept/reject filtering for messages, supports built-in downloading in several protocols, retries on failure, and allows the creation of callbacks, to customize processing.\n",
"\n",
"You need to provide a configuration as an argument when instantiating a subscriber.\n",
"the _sarracenia.config.no_file_config()_ returns an empty configuration without consulting\n",
Expand Down Expand Up @@ -252,7 +252,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.6"
"version": "3.10.12"
}
},
"nbformat": 4,
Expand Down
4 changes: 2 additions & 2 deletions docs/source/Tutorials/4_api_moth_sub_demo.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@
"source": [
"## Conclusion\n",
"\n",
"[Sarracenia.moth.amqp](../Reference/code.html#module-sarracenia.moth) is the lightest-weight way to add consumption of Sarracenia messages to your existing python stack. You explicitly ask for new messages when ready to use them. \n",
"[Sarracenia.moth.amqp](../Reference/code.rst#module-sarracenia.moth) is the lightest-weight way to add consumption of Sarracenia messages to your existing python stack. You explicitly ask for new messages when ready to use them. \n",
"\n",
"Things this type of integration does not provide:\n",
"\n",
Expand Down Expand Up @@ -418,7 +418,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.6"
"version": "3.10.12"
}
},
"nbformat": 4,
Expand Down
2 changes: 1 addition & 1 deletion docs/source/fr/Contribution/AMQPprimer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ autorisations et le nom de la fil d’attente) peuvent consommer à partir de la
de nommer la fil d’attente. Dans un autre protocole, tel que MQTT, on ne peut pas nommer la fil d’attente, et donc
ce modèle de traitement n’est pas pris en charge.

La convention de mappage décrite dans `Topic < ../../Reference/sr_post.7.rst#topic>`_, permet à
La convention de mappage décrite dans `Topic < ../../../Reference/sr_post.7.rst#topic>`_, permet à
MQTT d'établir des hiérarchies distinctes qui fournissent une distribution fixe entre
les travailleurs, mais pas exactement la fil d’attente partagée auto-équilibrée fournie par AMQP.

Expand Down
4 changes: 2 additions & 2 deletions docs/source/fr/Contribution/Documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,8 @@ ajouts ou des modifications apportés au nouveau composant.
Guide de Style
~~~~~~~~~~~~~~

L’exécution sur la ligne de commande doit être écrite dans le style suivant:
Un commentaire initial décrivant les étapes ou processus suivants ::
L’exécution sur la ligne de commande doit être écrite dans le style suivant.
Un commentaire initial décrivant les étapes ou processus suivants::

$ command 1
relevant output
Expand Down
4 changes: 2 additions & 2 deletions docs/source/fr/Contribution/Développement.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1281,7 +1281,7 @@ Pour plus de détails, voir `Quelle version est stable <https://github.com/MetPX



Création dune version
Création d'une version
----------------------

MetPX-Sarracenia est distribué de différentes manières, et chacun a son propre processus de construction.
Expand Down Expand Up @@ -1758,4 +1758,4 @@ permettre au code de se dégrader avec élégance.

Si la dépendance est ajoutée dans un plugin, alors il y a aussi une méthode pour celle décrite ici :

`Guide de Programmeur<../Explication/SarraPluginDev.html#ajout-de-dependance-python-dans-les-callbacks>`_
`Guide de Programmeur<../Explication/SarraPluginDev.html#ajout-de-dépendance-python-dans-les-callbacks>`_
2 changes: 1 addition & 1 deletion docs/source/fr/Explication/Aperçu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -250,4 +250,4 @@ D'autres logiciels, quelque peu similaires, aucun endossement ou jugement ne dev

- `Rsync <https://rsync.samba.org/>`_ moteur de transfert.
- `Lsyncd <https://github.com/axkibe/lsyncd>`_ moteur de transfert.
- `Zsync <https://zsync.moria.org.uk>`_ ( optimised rsync over HTTP. ) moteur de transfer.
- `ZSync <https://zsync.moria.org.uk>`_ ( optimised rsync over HTTP. ) moteur de transfer.
10 changes: 5 additions & 5 deletions docs/source/fr/Explication/Histoire/mesh_gts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -175,9 +175,10 @@ Les bases de données sont optimales pour les enregistrements de taille fixe. Pe
-------------------------------------------------------------------------------------------------------------------

.. note:
image de deux arbres, l'un invisible et calculé (la BD) d'une part sélectionné, visible,
inspectable (système de fichiers.) les performances de récupération doivent être les mêmes,
ils font la même chose.
image de deux arbres, l'un invisible et calculé (la BD) d'une part sélectionné, visible,
inspectable (système de fichiers.) les performances de récupération doivent être les mêmes,
ils font la même chose.
Il existe généralement deux grandes écoles de pensée sur le stockage des données météorologiques:
les fichiers et les bases de données. Pendant de nombreuses années, les données étaient relativement
Expand Down Expand Up @@ -751,8 +752,7 @@ Programmabilité/interopérabilité
--------------------------------

Une nouvelle application pour traiter sr_post messages peut être réimplémentée s’il y a un désir
de le faire, car en plus de la documentation complète, le code source d’une poignée
`d’implémentations<../Aperçu.html#implémentations>`_
de le faire, car en plus de la documentation complète, le code source d’une poignée `d’implémentations <../Aperçu.html#implémentations>`_
(Python, C, Go, node.js), est facilement accessible au public. L’implémentation python dispose
d’une interface de plug-in étendue disponible pour personnaliser le traitement de différentes
manières, par exemple pour ajouter des protocoles de transfert de fichiers et effectuer un pré
Expand Down
14 changes: 7 additions & 7 deletions docs/source/fr/Explication/Histoire/messages_v02.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ elle est remplacée par la page de manuel sr_post(7).
Ce dossier documente les conclusions/propositions finales, les raisonnements/débats
va ailleurs.

Les messages affichés comprennent quatre parties :
Sujet: .<version><type>. <src>(.<dir>.) *. <nom de fichier>
en-têtes : série de paires clé-valeur, selon les spécifications AMQP.
1ère ligne (champs séparés par des espaces) : <horodatage> <srcURL> <relURL><newline>
Reste du corps:
Les messages affichés comprennent quatre parties:

* Sujet: .<version><type>. <src>(.<dir>.) *. <nom de fichier>
* en-têtes : série de paires clé-valeur, selon les spécifications AMQP.
* 1ère ligne (champs séparés par des espaces) : <horodatage> <srcURL> <relURL><newline>
* Reste du corps.
La sujet du message se décompose comme suit ::

Expand Down Expand Up @@ -101,8 +102,7 @@ parts=<i|p>,<bsz>,<fzb>,<bno>,<remainder>
-- Récupération en plusieurs parties.

-- File Segment strategy::
i - inplace (ne pas créer de fichiers temporaires, juste lseek
dans le fichier.)
i - inplace (ne pas créer de fichiers temporaires, juste lseek dans le fichier.)
peut entraîner la création d’un fichier .srsig?
p - part files. Utilisez .part fichiers, suffixe fixe.
Je ne sais pas lequel sera par défaut.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/fr/Explication/SarraPluginDev.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

==================================
Guide de programmation Sarracenia
Guide de programmation sarracenia
==================================

---------------------------
Expand Down Expand Up @@ -176,7 +176,7 @@ ou flowcb accepte comme paramètre _options_ dans leurs routines __init__() ::
"""

L’exemple ci-dessus définit une option "accel\_wget\_command"
comme étant de type chaîne, avec la valeur par défaut _/usr/bin/wget_ .
comme étant de type chaîne, avec la valeur par défaut __/usr/bin/wget__ .

Autres méthodes utiles dans la classe sarracenia.config.Config :

Expand Down
2 changes: 1 addition & 1 deletion docs/source/fr/Explication/StrategieDetectionFichiers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Tableau de stratégie de détection de fichiers
| | - Vulnérable à des pannes réseau. |Réception de sources non-coopératives |
|| - Vulnérable à des horloges désynchr | |
| | onizés |(choix valable avec PDS) |
|nodupe_\ | | |
|nodupe__\ | | |
|fileAgeMin | |Si un processus re-écrit un fichier |
| | |souvent, mtime peut servire à réduire |
| | |le rhythme de publication d´avis. |
Expand Down
2 changes: 1 addition & 1 deletion docs/source/fr/Reference/sr3.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ se trouverait ici:
A la base, le répertoires *~/.config/sarra/default.conf* contient des paramètres
qui sont lus par défaut pour tout composant au démarrage. Dans le même répertoire,
*~/.config/sarra/credentials.conf*, il y a les identifiants (mots de passe) qui doivent
être utilisé par sarracenia ( `CREDENTIALS`_ pour plus de détails ).
être utilisé par sarracenia ( `CREDENTIALS <sr3_credentials.7.rst>`_ pour plus de détails ).

Il est également possible de définir la valeur de la variable XDG_CONFIG_HOME pour remplacer
le répertoire de base, ou sinon un fichier de configuration peut être placé dans n'importe quel
Expand Down
4 changes: 2 additions & 2 deletions docs/source/fr/Reference/sr3_cpump.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ VOIR AUSSI

`sr3(1) <sr3.1.html>`_ - Interface de ligne de commande principale de Sarracenia.

`sr3_post(1) <sr3_post.1.html>`_ - publication des annonces de fichiers (implémentation Python.)
`sr3_post(1) <sr3_post.1.rst>`_ - publication des annonces de fichiers (implémentation Python.)

`sr3_cpost(1) <sr3_cpost.1.html>`_ - publication des annonces de fichiers (implémentation C.)

Expand All @@ -113,7 +113,7 @@ VOIR AUSSI

`sr3_options(7) <sr3_options.7.html>`_ - liste de toute les options dans la langue de configuration.

`sr3_post(7) <sr3_post.7.html>`_ - le format des annonces
`sr3_post(7) <sr3_post.7.rst>`_ - le format des annonces

**Page d'acceuil:**

Expand Down
1 change: 1 addition & 0 deletions docs/source/fr/Reference/sr3_credentials.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ Détails pris en charge :
- ``prot_p`` - (FTPS) Utiliser une connexion de données sécurisée pour les connexions TLS (sinon, du texte clair est utilisé)
- ``bearer_token=<token>`` (ou ``bt=<token>``) - (HTTP) Jeton Bearer pour l’authentification
- ``login_method=<PLAIN|AMQPLAIN|EXTERNAL|GSSAPI>`` - (AMQP) Par défaut, la méthode de connexion sera automatiquement

déterminée. Cela peut être remplacé en spécifiant une méthode Particulière de connexion, ce qui peut être
nécessaire si un broker prend en charge plusieurs méthodes et qu’une méthode incorrecte est automatiquement
sélectionnée.
Expand Down
7 changes: 2 additions & 5 deletions docs/source/fr/Reference/sr3_options.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,7 @@ Variables

Il est possible de faire une substitution dans la valeur d'une option. Les valeurs sont représentées par ${name}.
Le nom peut être une variable d’environnement ordinaire, ou choisi parmi un certain nombre de variables déjà
intégrés:


::
intégrés::

varTimeOffset -5m
directory /monrépertoirelocal/${%Y%m%d_%Hh%m:%S.%f}/mydailies
Expand Down Expand Up @@ -362,7 +359,7 @@ au moins ce qui est spécifié.
Le **regexp pattern** peut être utilisé pour définir des parties du répertoire si une partie du message d'annonce est placée
entre parenthèses. **sender** peut utiliser ces parties pour générer le nom du répertoire.
Les chaînes de parenthèses entre les guillemets rst remplaceront le mot-clé **${0}** dans le nom du répertoire...
le second **{1} $ ** etc.
le second **{1} $** etc.

Exemple d’utilisation ::

Expand Down
3 changes: 1 addition & 2 deletions docs/source/fr/Reference/sr3_post.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,7 @@ Puis dans le ~/.bashrc sur le serveur exécutant la commande à distance ::
export SR_POST_CONFIG=$LC_SRSHIM
export LD_PRELOAD="libsrshim.so.1"
fi

SSH ne transmettra que les variables d'environnement qui commencent par LC\_ (locale) afin d'obtenir
les variables passées avec un minimum d'effort, nous utilisons ce préfixe.

Expand Down Expand Up @@ -444,8 +445,6 @@ Voir aussi

`sr3(1) <sr3.1.html>`_ - Interface de ligne de commande principale de Sarracenia.

`sr3_post(1) <sr3_post.1.html>`_ - publication des annonces de fichiers (implémentation python.)

`sr3_cpost(1) <sr3_cpost.1.html>`_ - publication des annonces de fichiers (implémentation c.)

`sr3_cpump(1) <sr3_cpump.1.html>`_ - implémentation en c du composant shovel. (copier les messages)
Expand Down
7 changes: 4 additions & 3 deletions docs/source/fr/Reference/sr_post.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ Version 03 du format des annonces de modification d'un fichier pour sr_post.

Un message sr_post se compose d’un sujet et du *BODY*

**AMQP Topic:** *<version>.{<dir>.}*
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**AMQP Topic:**
~~~~~~~~~~~~~~~

::
<version> = « v03 » la version du protocole ou du format.
Expand Down Expand Up @@ -228,7 +228,7 @@ encodé en utf8, de sorte que la limite de longueur réelle peut être inférieu
.. NOTE::

Sarracenia s’appuie sur des courtiers pour interpréter l’en-tête du thème. Les courtiers interprètent
des en-têtes spécifiques au protocole *AMQP, et ne décode pas efficacement la charge utile pour extraire les en-têtes.
des en-têtes spécifiques au protocole AMQP, et ne décode pas efficacement la charge utile pour extraire les en-têtes.
Par conséquent, l’en-tête du thème est stocké dans un en-tête AMQP, plutôt que dans la charge utile qui autorise le
filtrage côté serveur. Pour éviter d’envoyer deux fois les mêmes informations, cet en-tête est
omis de la charge utile JSON.
Expand Down Expand Up @@ -579,6 +579,7 @@ Un Autre Exemple
Le post résultant de la commande de sr_watch suivante, a noter la création du fichier 'foo'::

sr_watch -pbu sftp://[email protected]/ -path /data/shared/products/foo -pb amqp://broker.com

Ici, *sr_watch* vérifie si le fichier /data/shared/products/foo est modifié.
Lorsque cela se produit, *sr_watch* lit le fichier /data/shared/products/foo et calcule sa somme de contrôle.
Il crée ensuite un message d'annonce, se connecte à broker.com en tant qu’utilisateur « invité »
Expand Down
1 change: 0 additions & 1 deletion docs/source/jupyter/.gitignore

This file was deleted.

0 comments on commit 7235582

Please sign in to comment.