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

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

Du kanske vill överföra din Konfigurationsfiler till Docker-containern. Det enklaste sättet är att lägga till din aktuella katalog som /home/weblate-volym:

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

Kom igång¶

Konfigurationen för wlc lagras i ~/.config/weblate (se Konfigurationsfiler för andra platser). Skapa den så att den passar din miljö:

[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

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¶: Åsidosätter konfigurationsfilens sökväg, se 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¶

.weblate, .weblate.ini, weblate.ini: Konfigurationsfil placerad i projektkatalogen.
C:\Users\NAME\AppData\Roaming\weblate.ini: Användarkonfigurationsfil på Windows i den roamade profilen.
C:\Users\NAME\AppData\Local\weblate.ini: Användarkonfigurationsfil på Windows i den lokala profilen.
~/.config/weblate: Användarkonfigurationsfil.
/etc/xdg/weblate: Systemomfattande konfigurationsfil.

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.

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.

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.

Konfigurationsfilen är en INI-fil, till exempel:

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

API-nycklarna lagras i avsnittet [keys]:

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

Detta gör att du kan lagra nycklar i dina personliga inställningar, samtidigt som du använder .weblate-konfigurationen i VCS-arkivet så att wlc vet vilken server den ska kommunicera med.

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