Weblate-Client

Installation

Der Weblate-Client wird separat ausgeliefert und enthält das Python-Modul. Um die folgenden Befehle zu verwenden, müssen Sie wlc mit pip installieren:

pip install wlc

Sie können ihn auch direkt mit uvx ausführen:

uvx wlc --help

Hinweis

Sie können auch dieses wlc als ein Python-Modul verwenden, siehe wlc.

Docker-Nutzung

Der Weblate-Client ist auch als Docker-Image verfügbar.

Das Image ist auf Docker Hub veröffentlicht: https://hub.docker.com/r/weblate/wlc

Installieren:

docker pull weblate/wlc

Der Docker-Container verwendet die Standardeinstellungen von Weblate und verbindet sich mit der auf localhost bereitgestellten API. Die API-URL und der API_KEY können über die von Weblate akzeptierten Argumente konfiguriert werden.

Der Befehl zum Starten des Containers hat die folgende Syntax:

docker run --rm weblate/wlc [WLC_ARGS]

Beispiel:

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

You might want to pass your Konfigurationsdateien 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

Erste Schritte

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

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

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

Sie können dann Befehle auf dem Standardserver aufrufen:

wlc ls
wlc commit sandbox/hello-world

Siehe auch

Konfigurationsdateien

Ältere Konfiguration

Geändert in Version 1.17: Die alte Konfiguration mit uneingeschränktem key wird nicht mehr unterstützt.

Migrieren Sie Ihre alte Konfiguration:

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

Zu einer Konfiguration mit Schlüssel, die auf eine API-URL beschränkt ist:

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

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

Kurzfassung

wlc [arguments] <command> [options]

Die Befehle geben an, welcher Vorgang ausgeführt werden soll.

Beschreibung

Weblate Client ist eine Python-Bibliothek und ein Befehlszeilenprogramm zur Fernverwaltung von Weblate über Weblates REST-API. Das Befehlszeilenprogramm kann als wlc aufgerufen werden und ist in wlc integriert.

Argumente

Das Programm akzeptiert die folgenden Argumente, die das Ausgabeformat oder die zu verwendende Weblate-Instanz definieren. Diese müssen vor jedem Befehl eingegeben werden.

--format {csv,json,text,html}

Gibt das Ausgabeformat an.

--url URL

Gibt die API-URL an. Überschreibt jeden Wert, der in der Konfigurationsdatei gefunden wird, siehe Konfigurationsdateien. Die URL sollte mit /api/ enden, zum Beispiel https://hosted.weblate.org/api/.

--key KEY

Gibt den zu verwendenden API-Benutzerschlüssel an. Überschreibt jeden in der Konfigurationsdatei gefundenen Wert, siehe Konfigurationsdateien. Sie können Ihren Schlüssel in Ihrem Profil auf Weblate finden.

--config PATH

Load configuration only from PATH instead of the discovered global and project configuration files, see Konfigurationsdateien.

--config-section SECTION

Überschreibt den Abschnitt der verwendeten Konfigurationsdatei, siehe Konfigurationsdateien.

Befehle

Die folgenden Befehle sind verfügbar:

version

Gibt die aktuelle Version aus.

list-languages

Listet die in Weblate verwendeten Sprachen auf.

list-projects

Listet die Projekte in Weblate auf.

list-components

Listet die Komponenten in Weblate auf.

list-translations

Listet die Übersetzungen in Weblate auf.

show

Zeigt das Weblate-Objekt an (Übersetzung, Komponente oder Projekt).

ls

Listet das Weblate-Objekt auf (Übersetzung, Komponente oder Projekt).

commit

Committet Änderungen am Weblate-Objekt (Übersetzung, Komponente oder Projekt).

pull

Zieht Änderungen aus einem Remote-Repository in ein Weblate-Objekt (Übersetzung, Komponente oder Projekt).

push

Pusht Änderungen an Weblate-Objekten in ein Remote-Repository (Übersetzung, Komponente oder Projekt).

reset

Setzt Änderungen im Weblate-Objekt zurück, damit es mit dem Remote-Repository übereinstimmt (Übersetzung, Komponente oder Projekt).

cleanup

Entfernt alle nicht nachverfolgten Änderungen im Weblate-Objekt, um es an das Remote-Repository anzupassen (Übersetzung, Komponente oder Projekt).

repo

Zeigt den Repository-Status für ein bestimmtes Weblate-Objekt an (Übersetzung, Komponente oder Projekt).

stats

Zeigt detaillierte Statistiken für ein bestimmtes Weblate-Objekt an (Übersetzung, Komponente oder Projekt).

lock-status

Zeigt den Sperrstatus an.

lock

Sperrt die Komponente vor weiterer Übersetzung in Weblate.

unlock

Entsperrt die Übersetzung der Weblate-Komponente.

changes

Zeigt Änderungen für ein bestimmtes Objekt an.

download

Lädt eine Übersetzungsdatei herunter.

--convert

Wandelt das Dateiformat um, wenn nicht angegeben, erfolgt keine Umwandlung auf dem Server und die Datei wird unverändert in das Repository heruntergeladen.

--output

Gibt die Datei an, in der die Ausgabe gespeichert werden soll; wenn sie nicht angegeben wird, wird sie auf stdout ausgegeben.

upload

Lädt eine Übersetzungsdatei hoch.

--overwrite

Überschreibt vorhandene Übersetzungen beim Hochladen.

--input

Datei, aus welcher der Inhalt gelesen wird; wenn nicht angegeben, wird er von stdin gelesen.

--method

Zu verwendende Upload-Methode, siehe Importmethoden.

--fuzzy

Verarbeitung von ungenauen (zur Bearbeitung markierte) Zeichenketten (leer, process, approve)

--author-name

Autor-Name, um den aktuell authentifizierten Benutzer zu überschreiben

--author-email

Autor-E-Mail, um den aktuell authentifizierten Benutzer zu überschreiben

Hinweis

Genauere Informationen zum Aufruf einzelner Befehle erhalten Sie, wenn Sie --help übergeben, zum Beispiel: wlc ls --help.

Konfigurationsdateien

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

Globale Konfigurationsdatei unter Windows im Roaming-Profil.

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

Globale Konfigurationsdatei unter Windows im lokalen Profil.

~/.config/weblate

Globale Konfigurationsdatei auf Unix-ähnlichen Systemen.

/etc/xdg/weblate

Systemweite Fallback-Konfigurationsdatei.

Das Programm folgt der XDG-Spezifikation, so dass Sie die Platzierung der Konfigurationsdateien durch die Umgebungsvariablen XDG_CONFIG_HOME oder XDG_CONFIG_DIRS anpassen können.

Unter Windows sind die Verzeichnisse APPDATA und LOCALAPPDATA die bevorzugten Orte für die Konfigurationsdatei.

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

.weblate, .weblate.ini, weblate.ini

Projekt-Konfigurationsdatei, die im Repository abgelegt wird.

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

Die folgenden Einstellungen können im Abschnitt [weblate] konfiguriert werden (Sie können dies mit --config-section anpassen):

key

Removed in version 1.17: Verwenden Sie den Abschnitt [keys] zur Angabe von Schlüsseln, die für einzelne API-URLs gelten, siehe Ältere Konfiguration.

url

API-Server-URL, standardmäßig http://127.0.0.1:8000/api/.

translation

Pfad zur Standardübersetzung – Komponente oder Projekt.

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.

Die Konfigurationsdatei ist eine INI-Datei, zum Beispiel:

[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

Die API-Schlüssel werden im Abschnitt [keys] gespeichert:

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

Umgebungsvariablen

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

API-URL

WLC_KEY

API-Schlüssel

The configuration precedence (highest to lowest) is:

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.

Beispiele

Aktuelle Programmversion ausgeben:

$ wlc version
version: 0.1

Alle Projekte auflisten:

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

Übersetzungsdatei hochladen:

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

Es ist auch möglich anzugeben, an welchem Projekt wlc arbeiten soll:

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

Mit dieser Einrichtung können ausstehende Änderungen im aktuellen Projekt einfach committet werden:

$ wlc commit