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

You can also execute it directly using uvx:

uvx wlc --help

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

You might want to pass your Fichiers de configuration to the Docker container. When your repository contains a project configuration such as .weblate, the easiest approach is to add your current directory as the /home/weblate volume:

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

Pour commencer

The easiest way to get started is to create a personal wlc configuration in ~/.config/weblate (see Fichiers de configuration for the full discovery rules and other locations):

[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

Legacy configuration

Modifié dans la version 1.17: The legacy configuration using unscoped key is no longer supported.

Migrate legacy configuration:

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

To a configuration with key scoped to an API URL:

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

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

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

Load configuration only from PATH instead of the discovered global and project configuration files, see 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

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

cleanup

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

Affiche l’état du verrouillage.

lock

Verrouille le composant contre toute traduction dans Weblate.

unlock

Déverrouille la traduction d’un composant Weblate.

changes

Affiche les modifications d’un objet.

download

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

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

When --config is provided, wlc loads only that file.

Without --config, wlc first loads the discovered global configuration file from the standard platform-specific locations:

C:\Users\NAME\AppData\Roaming\weblate.ini

Global configuration file on Windows in the roamed profile.

C:\Users\NAME\AppData\Local\weblate.ini

Global configuration file on Windows in the local profile.

~/.config/weblate

Global configuration file on Unix-like systems.

/etc/xdg/weblate

System-wide fallback configuration file.

Le programme suit la spécification XDG, vous pouvez donc ajuster l’emplacement des fichiers de configuration à l’aide des variables d’environnement XDG_CONFIG_HOME ou XDG_CONFIG_DIRS.

Sous Windows les répertoires APPDATA et LOCALAPPDATA sont les endroits préférés pour le fichier de configuration.

After loading the global configuration, wlc loads the nearest project configuration file from the current directory or its parents:

.weblate, .weblate.ini, weblate.ini

Project configuration file placed in the repository.

Only the closest project configuration file is loaded. Configuration files in farther parent directories are ignored.

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

key

Supprimé dans la version 1.17: Use the [keys] section to specify keys scoped for individual API URLs, see Legacy configuration.

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.

retries, timeout, allowed_methods, backoff_factor, status_forcelist

Optional HTTP retry and timeout settings passed to urllib3. Use allowed_methods to list the request methods that may be retried. Current wlc releases use this setting name in place of the older method_whitelist option.

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

[weblate]
url = https://hosted.weblate.org/api/
translation = weblate/application
retries = 3
allowed_methods = PUT,POST,GET
backoff_factor = 0.2
status_forcelist = 429,500,502,503,504
timeout = 30

The API keys are stored in the [keys] section:

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

This allows you to store keys in your personal settings, while using the .weblate configuration in the VCS repository so that wlc knows which server it should talk to. In CI, keep only the repository configuration in version control and inject the API key using WLC_KEY.

Environment variables

Ajouté dans la version 1.18.0.

The API URL and key can also be configured using environment variables. This is especially useful for CI workflows where the repository provides the project configuration and WLC_KEY is injected as a secret:

WLC_URL

URL de l’API

WLC_KEY

Clé d’API

La précédence des paramètres est la suivante (le plus important en premier) :

1. Command-line arguments (--url, --key).

2. Environment variables (WLC_URL, WLC_KEY).

3. Configuration loaded from --config, or from the discovered global configuration plus the nearest project configuration when --config is not used.

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 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