Client Weblate

Instalare

The Weblate Client is shipped separately and includes the Python module. To use the commands below, you need to install wlc using pip:

pip install wlc

You can also execute it directly using uvx:

uvx wlc --help

Sugestie

You can also use this wlc as a Python module, see wlc.

Utilizarea Docker

Clientul Weblate este, de asemenea, disponibil ca o imagine Docker.

Imaginea este publicată pe Docker Hub: https://hub.docker.com/r/weblate/wlc

Instalare:

docker pull weblate/wlc

The Docker container uses Weblate Client defaults and connects to the API deployed on localhost. Configure the API URL and API key using the normal wlc arguments or environment variables, for example --url, --key, WLC_URL, and WLC_KEY. API keys are rejected over non-local http:// URLs by default; use HTTPS, loopback HTTP for local development, or explicitly opt in to insecure HTTP.

Comanda de lansare a containerului utilizează următoarea sintaxă:

docker run --rm weblate/wlc [WLC_ARGS]

Exemplu:

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

You might want to pass your Fișiere de configurare 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

When the mounted repository provides the API URL in project configuration and you pass an unscoped API key to the container, also pin the URL explicitly: WLC_KEY requires WLC_URL, and --key requires --url.

If the configured API URL uses non-local http:// and an API key is provided, the container refuses to send the key unless insecure HTTP is explicitly enabled. Prefer HTTPS; for legacy deployments, pass --allow-insecure-http or set WLC_ALLOW_INSECURE_HTTP.

Noțiuni introductive

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

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

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

Apoi puteți invoca comenzi pe serverul implicit:

wlc ls
wlc commit sandbox/hello-world

Vezi și

Fișiere de configurare

Legacy configuration

Schimbat în versiunea 1.17: 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

Sinopsis

wlc [arguments] <command> [options]

Comenzile indică de fapt ce operațiune trebuie efectuată.

Descriere

Weblate Client este o bibliotecă Python și un utilitar de linie de comandă pentru a gestiona Weblate de la distanță folosind Weblate’s REST API. Utilitarul de linie de comandă poate fi invocat ca wlc și este încorporat în wlc.

Argumente

Programul acceptă următoarele argumente care definesc formatul de ieșire sau instanța Weblate care trebuie utilizată. Acestea trebuie introduse înainte de orice comandă.

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

Specificați formatul de ieșire.

--url URL

Specificați URL-ul API. Suprascrie orice valoare găsită în fișierul de configurare, a se vedea Fișiere de configurare. URL-ul trebuie să se termine cu /api/, de exemplu https://hosted.weblate.org/api/.

--key KEY

Specify the API user key to use. Overrides any value found in the configuration file, see Fișiere de configurare. You can find your key in your profile on Weblate. When the API URL is loaded from automatically discovered project configuration, --key must be used together with --url. API keys are rejected over non-local http:// URLs by default.

--allow-insecure-http

Allow sending API keys over non-local http:// URLs. Prefer HTTPS or loopback HTTP instead; this option is intended only for legacy deployments where HTTPS is not available. This option only enables insecure HTTP for the current run; omitting it does not disable allow_insecure_http from configuration.

--config PATH

Load configuration only from PATH instead of the discovered global and project configuration files, see Fișiere de configurare.

--config-section SECTION

Suprascrie secțiunea fișierului de configurare în uz, a se vedea Fișiere de configurare.

Comenzi

Sunt disponibile următoarele comenzi:

version

Tipărește versiunea curentă.

list-languages

Listează limbile utilizate în Weblate.

list-projects

Listează proiectele din Weblate.

list-components

Listează componentele din Weblate.

list-translations

Listează traducerile din Weblate.

show

Afișează obiectul Weblate (traducere, componentă sau proiect).

ls

Listează obiectul Weblate (traducere, componentă sau proiect).

commit

Comută modificările efectuate într-un obiect Weblate (traducere, componentă sau proiect).

pull

Atrage modificările din depozitul de la distanță în obiectul Weblate (traducere, componentă sau proiect).

push

Împinge modificările obiectelor Weblate în depozitul la distanță (traducere, componentă sau proiect).

reset

Resetează modificările din obiectul Weblate pentru a se potrivi cu depozitul la distanță (traducere, componentă sau proiect).

cleanup

Îndepărtează orice modificări netrasate într-un obiect Weblate pentru a se potrivi cu depozitul la distanță (traducere, componentă sau proiect).

repo

Afișează starea depozitului pentru un anumit obiect Weblate (traducere, componentă sau proiect).

stats

Afișează statistici detaliate pentru un anumit obiect Weblate (traducere, componentă sau proiect).

lock-status

Afișează starea de blocare.

lock

Blochează componenta de la traducerea ulterioară în Weblate.

unlock

Deblochează traducerea componentei Weblate.

changes

Afișează modificările pentru un anumit obiect.

download

Descarcă un fișier de traducere.

--convert

Convertește formatul fișierului; dacă nu este specificat, nu are loc nicio conversie pe server, iar fișierul este descărcat ca atare în depozit.

--output

Specifică fișierul în care se salvează ieșirea; dacă nu este specificat, aceasta este imprimată în stdout.

upload

Încarcă un fișier de traducere.

--overwrite

Suprascrieți traducerile existente în momentul încărcării.

--input

Fișier din care se citește conținutul; dacă nu este specificat, se citește din stdin.

--method

Metoda de încărcare care trebuie utilizată, a se vedea Metode de import.

--fuzzy

Procesarea șirurilor fuzzy (marcate pentru editare) (empty, process, approve)

--author-name

Numele autorului, pentru a suprascrie utilizatorul autentificat în prezent

--author-email

E-mailul autorului, pentru a suprascrie utilizatorul autentificat în prezent

Sugestie

Puteți obține informații mai detaliate despre invocarea comenzilor individuale trecând --help, de exemplu: wlc ls --help.

Fișiere de configurare

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.

The program follows the XDG specification, so you can adjust the placement of config files by environment variables XDG_CONFIG_HOME or XDG_CONFIG_DIRS.

On Windows APPDATA and LOCALAPPDATA directories are the preferred locations for the configuration file.

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.

Următoarele setări pot fi configurate în secțiunea [weblate] (puteți personaliza acest lucru prin --config-section):

key

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

url

URL-ul serverului API, valoarea implicită este http://127.0.0.1:8000/api/.

translation

Calea către traducerea implicită - componentă sau proiect.

allow_insecure_http

Allow API keys over non-local http:// URLs, defaults to false. Loopback HTTP URLs, such as http://127.0.0.1:8000/api/, remain allowed for local development without this option. Prefer HTTPS instead of enabling this setting. Automatically discovered project configuration files cannot enable this option; set it in user configuration, an explicit --config file, WLC_ALLOW_INSECURE_HTTP, or --allow-insecure-http. The setting is cumulative: any trusted source that enables insecure HTTP is enough, and false or unset values from command-line or environment sources do not disable it.

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.

Fișierul de configurare este un fișier INI, de exemplu:

[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
allow_insecure_http = false

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. The [keys] lookup is scoped to the exact API URL.

In CI, unscoped keys must pin the API URL explicitly: set both WLC_URL and WLC_KEY, or use --url together with --key.

Environment variables

Added in version 1.18.0.

Schimbat în versiunea 2.0.1: Unscoped API keys require an explicit API URL when project configuration is discovered automatically. API keys are rejected over non-local http:// URLs unless insecure HTTP is explicitly enabled.

The API URL and key can also be configured using environment variables. This is especially useful for CI workflows where WLC_URL pins the destination and WLC_KEY is injected as a secret:

WLC_URL

URL-UL API

WLC_KEY

API key. When the API URL would otherwise come from automatically discovered project configuration, WLC_KEY is accepted only together with WLC_URL. API keys are rejected over non-local http:// URLs by default.

WLC_ALLOW_INSECURE_HTTP

Set to 1, true, yes, or on to allow API keys over non-local http:// URLs. Prefer HTTPS or loopback HTTP instead. Other values, such as 0 or false, are treated as unset and do not disable allow_insecure_http from configuration.

The same protection applies to command-line arguments: --key is accepted with automatically discovered project configuration only when --url is provided.

The API URL and key 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.

The insecure HTTP opt-in is enable-only rather than a normal precedence setting. It is enabled when --allow-insecure-http is passed, when WLC_ALLOW_INSECURE_HTTP has a true value, or when allow_insecure_http is enabled in trusted configuration. Automatically discovered project configuration cannot enable it; set it in user configuration or pass an explicit --config file instead.

Exemple

Imprimă versiunea curentă a programului:

$ wlc version
version: 0.1

Enumerați toate proiectele:

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

Încărcați fișierul de traducere:

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

You can also designate what project wlc should work on:

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

Cu această configurație, este ușor să confirmați modificările în așteptare în proiectul curent:

$ wlc commit