Weblate-klient

Installation

Weblate Client levereras separat och innehåller Python-modulen. För att kunna använda kommandona nedan måste du installera wlc med pip:

pip install wlc

You can also execute it directly using uvx:

uvx wlc --help

Råd

Du kan också använda detta wlc som en Python-modul, se wlc.

Användning av Docker

Weblate Client finns även tillgänglig som Docker-bild.

Bilden är publicerad på Docker Hub: https://hub.docker.com/r/weblate/wlc

Installerar:

docker pull weblate/wlc

Docker-containern använder Weblates standardinställningar och ansluter till API:et som är distribuerat i localhost. API-URL:en och API_KEY kan konfigureras genom de argument som accepteras av Weblate.

Kommandot för att starta containern använder följande syntax:

docker run --rm weblate/wlc [WLC_ARGS]

Exempel:

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

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

Kom igång

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

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

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

Du kan sedan anropa kommandon på standardservern:

wlc ls
wlc commit sandbox/hello-world

Se även

Konfigurationsfiler

Äldre konfiguration

Förändrat i version 1.17: Den äldre konfigurationen med ospecificerad key stöds inte längre.

Migrera äldre konfiguration:

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

Till en konfiguration med nyckel som omfattar en API-URL:

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

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

Sammanfattning

wlc [arguments] <command> [options]

Kommandon anger faktiskt vilken åtgärd som ska utföras.

Beskrivning

Weblate Client är ett Python-bibliotek och ett kommandoradsverktyg för att fjärrstyra Weblate med hjälp av Weblates REST API. Kommandoradsverktyget kan anropas som wlc och är inbyggt i wlc.

Argument

Programmet accepterar följande argument som definierar utdataformat eller vilken Weblate-instans som ska användas. Dessa måste anges före alla kommandon.

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

Ange utdataformatet.

--url URL

Ange API-URL. Åsidosätter alla värden som finns i konfigurationsfilen, se Konfigurationsfiler. URL:en ska sluta med /api/, till exempel https://hosted.weblate.org/api/.

--key KEY

Ange vilken API-användarkod som ska användas. Överskriver alla värden som finns i konfigurationsfilen, se Konfigurationsfiler. Du hittar din kod i din profil på Weblate.

--config PATH

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

--config-section SECTION

Åsidosätter konfigurationsfilens avsnitt som används, se Konfigurationsfiler.

Kommandon

Följande kommandon är tillgängliga:

version

Skriver ut den aktuella versionen.

list-languages

Listor över språk som används i Weblate.

list-projects

Listar projekt i Weblate.

list-components

Listar komponenter i Weblate.

list-translations

Listar översättningar i Weblate.

show

Visar Weblate-objekt (översättning, komponent eller projekt).

ls

Listar Weblate-objekt (översättning, komponent eller projekt).

commit

Bekräftar ändringar som gjorts i ett Weblate-objekt (översättning, komponent eller projekt).

pull

Hämtar ändringar från fjärrarkivet till Weblate-objekt (översättning, komponent eller projekt).

push

Skickar Weblate-objektändringar till fjärrförvaret (översättning, komponent eller projekt).

reset

Återställer ändringar i Weblate-objekt så att de matchar det fjärranslutna arkivet (översättning, komponent eller projekt).

cleanup

Tar bort alla ospårade ändringar i ett Weblate-objekt så att det matchar det fjärranslutna arkivet (översättning, komponent eller projekt).

repo

Visar arkivstatus för ett visst Weblate-objekt (översättning, komponent eller projekt).

stats

Visar detaljerad statistik för ett visst Weblate-objekt (översättning, komponent eller projekt).

lock-status

Visar låsstatus.

lock

Låser komponenten från vidare översättning i Weblate.

unlock

Låser upp översättning av Weblate-komponenten.

changes

Visar ändringar för ett visst objekt.

download

Hämtar en översättningsfil.

--convert

Konverterar filformat. Om inget anges sker ingen konvertering på servern och filen laddas ned till arkivet i befintligt format.

--output

Anger fil att spara utdata i. Om inget anges skrivs utdata till stdout.

upload

Laddar upp en översättningsfil.

--overwrite

Skriv över befintliga översättningar vid uppladdning.

--input

Fil från vilken innehållet läses. Om inget anges läses det från stdin.

--method

Uppladdningsmetod att använda, se Importmetoder.

--fuzzy

Bearbetning av fuzzy-strängar (markerade för redigering) (tom, bearbeta, godkänn)

--author-name

Författarens namn, för att åsidosätta den för närvarande autentiserade användaren

--author-email

Författarens e-postadress, för att åsidosätta den för närvarande autentiserade användaren

Råd

Du kan få mer detaljerad information om hur du använder enskilda kommandon genom att ange --help, till exempel: wlc ls --help.

Konfigurationsfiler

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.

Programmet följer XDG-specifikationen, så du kan justera placeringen av konfigurationsfiler med miljövariablerna XDG_CONFIG_HOME eller XDG_CONFIG_DIRS.

I Windows är katalogerna APPDATA och LOCALAPPDATA de föredragna platserna för konfigurationsfilen.

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.

Följande inställningar kan konfigureras i avsnittet [weblate] (du kan anpassa detta med --config-section):

key

Removed in version 1.17: Använd avsnittet [keys] för att ange nycklar som gäller för enskilda API-URL:er, se Äldre konfiguration.

url

API-serverns URL, standardvärdet är http://127.0.0.1:8000/api/.

translation

Sökväg till standardöversättningen – komponent eller 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.

Konfigurationsfilen är en INI-fil, till exempel:

[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

API-nycklarna lagras i avsnittet [keys]:

[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

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

URL för API

WLC_KEY

API-nyckel

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.

Exempel

Skriv ut aktuell programversion:

$ wlc version
version: 0.1

Lista alla projekt:

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

Ladda upp översättningsfil:

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

Du kan också ange vilket projekt wlc ska arbeta med:

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

Med denna inställning är det enkelt att bekräfta väntande ändringar i det aktuella projektet:

$ wlc commit