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

You can also execute it directly using uvx:

uvx wlc --help

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

You might want to pass your Konfigurációs fájlok 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

Kezdeti lépések

The easiest way to get started is to create a personal wlc configuration in ~/.config/weblate (see Konfigurációs fájlok for the full discovery rules and other locations):

[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

Legacy configuration

A 1.17 verzióban változott: 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

Á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

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

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

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

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

lock

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

unlock

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

changes

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

download

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

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

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.

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.

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.

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

key

Removed in version 1.17: Use the [keys] section to specify keys scoped for individual API URLs, see Legacy configuration.

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.

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.

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

[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

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-cím

WLC_KEY

API-kulcs

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.

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