Client Weblate¶

Installation¶

Weblate Client est livré séparément et contient le module Python. Pour utiliser la commande ci-dessous, vous devez installer wlc en utilisant pip :

pip install wlc

Indication

Vous pouvez utiliser ce wlc en tant que module Python, voir wlc.

Utilisation de Docker¶

Le client Weblate est également disponible sous forme d’image Docker.

L’image est publiée sur le hub de Docker : https://hub.docker.com/r/weblate/wlc

Installation :

docker pull weblate/wlc

Le conteneur Docker utilise les paramètres par défaut de Weblate et se connecte à l’API déployée dans localhost. L’URL de l’API ainsi que API_KEY peuvent être configurés en tant qu’arguments acceptés par Weblate.

La commande pour lancer le conteneur utilise la syntaxe suivante :

docker run --rm weblate/wlc [WLC_ARGS]

Exemple :

docker run --rm weblate/wlc --url https://hosted.weblate.org/api/ list-projects

Si vous souhaitez passer votre Fichiers de configuration au conteneur Docker, la manière la plus facile est d’ajouter votre répertoire courant en tant que volume /home/weblate :

docker run --volume $PWD:/home/weblate --rm weblate/wlc show

Pour commencer¶

La configuration de wlc est stockée dans ~/.config/weblate (voir Fichiers de configuration pour les autres emplacements), veuillez la créer selon votre environnement.

[weblate]
url = https://hosted.weblate.org/api/

[keys]
https://hosted.weblate.org/api/ = APIKEY

Vous pouvez alors invoquer des commandes sur le serveur par défaut :

wlc ls
wlc commit sandbox/hello-world

Voir aussi

Fichiers de configuration

Synopsis¶

wlc [arguments] <command> [options]

Les commandes représentent actuellement les opérations à réaliser.

Description¶

Weblate Client est une bibliothèque Python et un utilitaire en mode ligne de commande pour gérer Weblate à distance en utilisant API REST de Weblate. Cet utilitaire peut être appelé par wlc et il est construit sur wlc.

Arguments¶

Le programme accepte les arguments suivants qui définissent le format de sortie ou l’instance de Weblate à utiliser. Ils doivent être fournis avant toute commande.

--format {csv,json,text,html}¶: Spécifiez le format de sortie.

--url URL¶: Spécifier l’URL de l’API. Redéfinit toute valeur présente dans le fichier de configuration, voir Fichiers de configuration. L’URL doit se terminer par /api/, par exemple https://hosted.weblate.org/api/.

--key KEY¶: Spécifie la clé utilisateur de l’API à utiliser. Remplace toute valeur trouvée dans le fichier de configuration, voir Fichiers de configuration. Votre clé se trouve dans votre profil sur Weblate.

--config PATH¶: Surcharge le chemin du fichier d’utilisation, voir Fichiers de configuration.

--config-section SECTION¶: Surcharge la section du fichier d’utilisation en cours d’utilisation, voir Fichiers de configuration.

Commandes¶

Les commandes suivantes sont disponibles :

version¶: Imprime la version actuelle.

list-languages¶: Liste les langues utilisées dans Weblate.

list-projects¶: Liste des projets dans Weblate.

list-components¶: Liste les composants dans Weblate.

list-translations¶: Liste les traductions dans Weblate.

show¶: Affiche l’objet Weblate (traduction, composant ou projet).

ls¶: Liste les objets Weblate (traduction, composant ou projet).

commit¶: Valide les modifications faites dans un objet Weblate (traduction, composant ou projet).

pull¶: Met à jour Weblate avec les modifications du dépôt distant (traduction, composant ou projet).

push¶: Pousse les modifications Weblate vers le dépôt distant (traduction, composant ou projet).

reset¶: Ajouté dans la version 0.7: Supporté depuis wlc 0.7.

Annule les modifications Weblate pour correspondre au dépôt distant (traduction, composant,ou projet).

cleanup¶: Ajouté dans la version 0.9: Supporté depuis wlc 0.9.

Supprime toute modification non suivie dans un objet Weblate pour correspondre au dépôt distant (traduction, composant ou projet).

repo¶: Affiche l’état du dépôt pour un objet Weblate donné (traduction, composant ou projet).

stats¶: Affiche les statistiques détaillées d’un objet Weblate (traduction, composant ou projet).

lock-status¶: Ajouté dans la version 0.5: Supporté depuis wlc 0.5.

Affiche l’état du verrouillage.

lock¶: Ajouté dans la version 0.5: Supporté depuis wlc 0.5.

Verrouille le composant contre toute traduction dans Weblate.

unlock¶: Ajouté dans la version 0.5: Supporté depuis wlc 0.5.

Déverrouille la traduction d’un composant Weblate.

changes¶: Ajouté dans la version 0.7: Supporté depuis wlc 0.7 et Weblate 2.10.

Affiche les modifications d’un objet.

download¶

Ajouté dans la version 0.7: Supporté depuis wlc 0.7.

Télécharge un fichier de traduction.

--convert¶: Convertit le format du fichier ; si rien n’est spécifié, aucune conversion n’est appliquée sur le serveur et le fichier est téléchargé tel quel dans le dépôt.

--output¶: Fichier dans lequel les sorties seront enregistrées ; si rien n’est spécifié, stdout sera utilisé.

upload¶

Ajouté dans la version 0.9: Supporté depuis wlc 0.9.

Charge un fichier de traduction.

--overwrite¶: Remplacer les traductions existantes lors du téléversement.

--input¶: Fichier à partir duquel le contenu est lu. S’il n’est pas spécifié, le contenu est lu à partir de l’entrée standard stdin.

--method¶: Méthode de téléversement à utiliser, voir Méthodes d’importation.

--fuzzy¶: Fuzzy (marked for edit) strings processing (empty, process, approve)

--author-name¶: Nom de l’auteur, pour surcharger l’utilisateur actuellement connecté

--author-email¶: Auteur du courriel, pour surcharger l’utilisateur actuellement connecté

Indication

Vous pouvez obtenir plus d’informations sur la commande en l’appelant avec l’option --help, par exemple : wlc ls --help.

Fichiers de configuration¶

.weblate, .weblate.ini, weblate.ini: Fichier de configuration par projet
C:\Users\NAME\AppData\weblate.ini: Fichier de configuration utilisateur sous Windows.
~/.config/weblate: Fichier de configuration utilisateur
/etc/xdg/weblate: Fichier de configuration global du système

Le programme suit la spécification XDG, vous pouvez donc ajuster l’emplacement des fichiers à l’aide des variables d’environnement XDG_CONFIG_HOME ou XDG_CONFIG_DIRS. Sous Windows, le répertoire APPDATA est l’endroit préféré pour le fichier de configuration.

Les paramètres suivants peuvent être configurés dans la section [weblate] (vous pouvez personnaliser cela avec --config-section) :

key: Clé d’API pour accéder à Weblate.

url: URL du serveur API, par défaut http://127.0.0.1:8000/api/.

translation: Chemin vers la traduction par défaut - composant ou projet.

Le fichier de configuration est un fichier INI, par exemple :

[weblate]
url = https://hosted.weblate.org/api/
key = APIKEY
translation = weblate/application

De plus, les clés d’API peuvent être stockées dans la section [keys] :

[keys]
https://hosted.weblate.org/api/ = APIKEY

Cela vous permet de stocker les clés dans vos paramètres personnels tout en utilisant les paramètres .weblate dans le dépôt VCS de sorte à ce que wlc sache avec quel serveur il doit dialoguer.

Exemples¶

Imprimer la version actuelle du programme :

$ wlc version
version: 0.1

Lister tous les projets :

$ wlc list-projects
name: Hello
slug: hello
url: http://example.com/api/projects/hello/
web: https://weblate.org/
web_url: http://example.com/projects/hello/

Téléverser un fichier de traduction :

$ wlc upload project/component/language --input /tmp/hello.po

Vous pouvez aussi déclarer le projet sur lequel :program: wlc va travailler :

$ cat .weblate
[weblate]
url = https://hosted.weblate.org/api/
translation = weblate/application

$ wlc show
branch: main
file_format: po
source_language: en
filemask: weblate/locale/*/LC_MESSAGES/django.po
git_export: https://hosted.weblate.org/git/weblate/application/
license: GPL-3.0+
license_url: https://spdx.org/licenses/GPL-3.0+
name: Application
new_base: weblate/locale/django.pot
project: weblate
repo: git://github.com/WeblateOrg/weblate.git
slug: application
template:
url: https://hosted.weblate.org/api/components/weblate/application/
vcs: git
web_url: https://hosted.weblate.org/projects/weblate/application/

Avec ce paramètre il est facile de valider les modifications en attente dans le projet en cours :

$ wlc commit