Weblate kliens

Telepítés

A Weblate kliens külön csomagban érhető el, és tartalmazza a Python modult. Az alábbi parancsok használatához telepítse a wlc eszközt pip segítségével:

pip install wlc

Tipp

A wlc Python modulként is használható, lásd: wlc.

Docker használat

A Weblate kliens Docker-képként is elérhető.

Az kép elérhető a Docker Hub-on: https://hub.docker.com/r/weblate/wlc

Telepítés:

docker pull weblate/wlc

A Docker-konténer a Weblate alapértelmezett beállításait használja, és a helyi gépen futó API-hoz csatlakozik. Az API URL-je és az API_KEY a Weblate által elfogadott argumentumokon keresztül konfigurálható.

A konténer indításához használt parancs az alábbi szintaxist követi:

docker run --rm weblate/wlc [WLC_ARGS]

Példa:

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

Érdemes lehet a saját Konfigurációs fájlok fájlját is átadni a Docker-konténernek – legegyszerűbb, ha az aktuális könyvtárat a /home/weblate kötetként csatolja be:

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

Kezdeti lépések

A wlc konfigurációja a ~/.config/weblate fájlban található (egyéb helyekről lásd: Konfigurációs fájlok), ezt hozza létre saját környezete alapján:

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

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

Ezután a parancsokat már a beállított kiszolgálón hajthatja végre:

wlc ls
wlc commit sandbox/hello-world

Lásd még

Konfigurációs fájlok

Áttekintés

wlc [arguments] <command> [options]

A parancsok azt jelölik, milyen műveletet kíván végrehajtani.

Leírás

A Weblate kliens egy Python-könyvtár és parancssori segédprogram, amellyel a Weblate távolról kezelhető a REST API segítségével. A parancssori eszköz a wlc paranccsal hívható meg, és a wlc modul része.

Argumentumok

A program az alábbi argumentumokat fogadja el, amelyek a kimeneti formátumot vagy a használt Weblate-példányt határozzák meg. Ezeket a parancs előtt kell megadni.

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

A kimeneti formátum megadása.

--url URL

Az API URL megadása. Felülír minden, a konfigurációs fájlban szereplő értéket, lásd: Konfigurációs fájlok. Az URL végződjön /api/ karakterlánccal, például: https://hosted.weblate.org/api/.

--key KEY

A használni kívánt API-felhasználói kulcs megadása. Felülír minden, a konfigurációs fájlban szereplő értéket, lásd: Konfigurációs fájlok. A kulcsot a Weblate-profiljában találja.

--config PATH

A konfigurációs fájl elérési útjának felülírása, lásd: Konfigurációs fájlok.

--config-section SECTION

A konfigurációs fájl használatban lévő szakaszának felülírása, lásd: Konfigurációs fájlok.

Parancsok

Az alábbi parancsok érhetők el:

version

Az aktuális verzió kiírása.

list-languages

A Weblate-ben használt nyelvek listázása.

list-projects

A Weblate-projektek listázása.

list-components

A Weblate-összetevők listázása.

list-translations

A Weblate-fordítások listázása.

show

Weblate-objektum (fordítás, összetevő vagy projekt) megjelenítése.

ls

Weblate-objektum (fordítás, összetevő vagy projekt) listázása.

commit

Módosítások véglegesítése egy Weblate-objektumban (fordítás, összetevő vagy projekt).

pull

A távoli tárolóból származó változások letöltése a Weblate-objektumba (fordítás, összetevő vagy projekt).

push

A Weblate-objektumban történt változások feltöltése a távoli tárolóba (fordítás, összetevő vagy projekt).

reset

Added in version 0.7: A wlc 0.7-es verziójától érhető el.

A Weblate-objektumban végzett módosítások visszaállítása a távoli tároló állapotának megfelelően (fordítás, összetevő vagy projekt).

cleanup

Added in version 0.9: A wlc 0.9-es verziójától támogatott.

Minden nem követett módosítás eltávolítása a Weblate-objektumból a távoli tároló állapotának megfelelően (fordítás, összetevő vagy projekt).

repo

A megadott Weblate-objektumhoz tartozó tároló állapotának megjelenítése (fordítás, összetevő vagy projekt).

stats

Részletes statisztikák megjelenítése egy megadott Weblate-objektumhoz (fordítás, összetevő vagy projekt).

lock-status

Added in version 0.5: A wlc 0.5-ös verziójától támogatott.

Zárolási állapot megjelenítése.

lock

Added in version 0.5: A wlc 0.5-ös verziójától támogatott.

Összetevő zárolása a Weblate-ben történő további fordítás elől.

unlock

Added in version 0.5: A wlc 0.5-ös verziójától támogatott.

A Weblate-összetevő fordításának feloldása (zárolás megszüntetése).

changes

Added in version 0.7: A wlc 0.7-es és a Weblate 2.10-es verziójától támogatott.

Egy megadott objektumhoz tartozó módosítások megjelenítése.

download

Added in version 0.7: A wlc 0.7-es verziójától érhető el.

Fordítási fájl letöltése.

--convert

Fájlformátum konvertálása – ha nincs megadva, nem történik konverzió, és a fájl az eredeti formátumban kerül letöltésre a tárolóból.

--output

A kimeneti fájl mentési helyének megadása – ha nincs megadva, az adatok a standard kimenetre kerülnek.

upload

Added in version 0.9: A wlc 0.9-es verziójától támogatott.

Fordítási fájl feltöltése.

--overwrite

A feltöltés során a meglévő fordítások felülírása.

--input

A fájl, amelyből a tartalom beolvasásra kerül – ha nincs megadva, a tartalom a standard bemenetről olvassa be.

--method

A használandó feltöltési módszer, lásd: Importálási módok.

--fuzzy

Szerkesztést igénylő (zavaros) szövegek feldolgozása (üres, process, approve)

--author-name

Szerző neve, az aktuálisan hitelesített felhasználó felülírásához.

--author-email

Szerző e-mail címe, az aktuálisan hitelesített felhasználó felülírásához.

Tipp

Részletesebb információt kaphat az egyes parancsok használatáról a --help kapcsolóval, például: wlc ls --help.

Konfigurációs fájlok

.weblate, .weblate.ini, weblate.ini

Projektkönyvtárban elhelyezett konfigurációs fájl.

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

Felhasználói konfigurációs fájl Windows rendszeren, a roaming profilban.

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

Felhasználói konfigurációs fájl Windows rendszeren, a helyi profilban.

~/.config/weblate

Felhasználói konfigurációs fájl.

/etc/xdg/weblate

Rendszerszintű konfigurációs fájl.

A program követi az XDG specifikációt, így a konfigurációs fájlok helye a XDG_CONFIG_HOME vagy XDG_CONFIG_DIRS környezeti változókkal módosítható.

Windows rendszeren az APPDATA és LOCALAPPDATA könyvtárak az ajánlott helyek a konfigurációs fájl számára.

A [weblate] szekcióban az alábbi beállítások adhatók meg (ez testreszabható a --config-section segítségével):

key

API-kulcs a Weblate eléréséhez.

url

API szerver URL, alapértelmezés szerint: http://127.0.0.1:8000/api/.

translation

Az alapértelmezett fordítás elérési útja – összetevő vagy projekt.

A konfigurációs fájl INI formátumú, például:

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

Továbbá API-kulcsok a [keys] szekcióban is megadhatók:

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

Ez lehetővé teszi, hogy a hitelesítési kulcsokat a személyes beállításokban tárolja, miközben a .weblate konfigurációt a VCS-tárolóban használja, így a wlc tudja, melyik kiszolgálóval kell kommunikálnia.

Példák

A jelenlegi programverzió kiírása:

$ wlc version
version: 0.1

Projektek listázása:

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

Fordítási fájl feltöltése:

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

Azt is megadhatja, hogy a wlc melyik projekttel dolgozzon:

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

Ezzel a beállítással egyszerűen véglegesíthetők a jelenlegi projekt függőben lévő módosításai:

$ wlc commit