Клієнт Weblate

Установлення

Клієнт Weblate постачається окремо і включає до себе модуль Python. Щоб користуватися наведеними нижче командами, вам слід встановити wlc:

pip install wlc

Користування Docker

Крім того, клієнт Weblate доступний у форматі образу для Docker.

Образ оприлюднено на Docker Hub: https://hub.docker.com/r/weblate/wlc

Установлення:

docker pull weblate/wlc

Контейнер Docker використовує типові параметри Weblate і встановлює з’єднання із програмним інтерфейсом, який розгорнуто на локальному вузлі. URL-адресу API та API_KEY можна налаштувати за допомогою аргументів, які приймаються Weblate.

У команді запуску контейнера використовують такий синтаксис:

docker run --rm weblate/wlc [WLC_ARGS]

Приклад:

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

Якщо вам хочеться передати ваш Файли налаштувань до контейнера Docker, найпростішим способом буде додати ваш поточний каталог томом /home/weblate:

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

Перші кроки

Налаштування wlc зберігаються у ~/.config/weblate (інші місця див. у Файли налаштувань). Будь ласка, створіть його так, щоб усе відповідало вашому середовищу:

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

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

Далі, ви можете викликати команди на типовому сервері:

wlc ls
wlc commit sandbox/hello-world

Дивись також

Файли налаштувань

Короткий опис

wlc [arguments] <command> [options]

Команди вказують на те, яку дію має бути виконано.

Опис

Клієнт Weblate складається з бібліотеки мовою Python і засобу командного рядка для керування Weblate віддалено за допомогою програмного інтерфейсу. Викликати засіб командного рядка можна за допомогою команди wlc, його вбудовано до wlc.

Аргументи

Програма приймає вказані нижче аргументи, які визначають формат виведення даних або екземпляр Weblate, яким слід скористатися. Ці аргументи слід вводити перед будь-якою командою.

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

Вказати формат виведення даних.

--url URL

Вказати адресу програмного інтерфейсу. Має вищий пріоритет за будь-яке значення, яке буде виявлено у файлі налаштувань, див. Файли налаштувань. Адреса має завершуватися /api/. Приклад: https://hosted.weblate.org/api/.

--key KEY

Вказати ключ до програмного інтерфейсу, яким слід скористатися. Має вищий пріоритет за будь-яке значення, яке буде виявлено у файлі налаштувань, див Файли налаштувань. Знайти ваш ключ можна у профілі на Weblate.

--config PATH

Перевизначає шлях до файла налаштувань, див. Файли налаштувань.

--config-section SECTION

Перевизначає розділ файла налаштувань для використання, див. Файли налаштувань.

Команди

Можна скористатися такими командами:

version

Виводить поточну версію.

list-languages

Виводить список використаних у Weblate мов.

list-projects

Виводить список проєктів у Weblate.

list-components

Виводить список складників у Weblate.

list-translations

Виводить список перекладів у Weblate.

show

Показує об’єкт Weblate (переклад, складник або проєкт).

ls

Виводить список об’єкта Weblate (переклад, складник або проєкт).

commit

Вносить зміни, які виконано в об’єкті Weblate (перекладі, складнику або проєкті).

pull

Отримує зміни у віддаленому репозиторії до об’єкта Weblate (перекладу, складника або проєкту).

push

Записує зміни у об’єкті Weblate до віддаленого репозиторію (переклад, складник або проєкт).

reset

Нове в версії 0.7: Підтримку передбачено з версії wlc 0.7.

Скидає зміни в об’єкті Weblate так, щоб дані збігалися із даними у віддаленому репозиторії (переклад, складник або проєкт).

cleanup

Нове в версії 0.9: Підтримку передбачено з версії wlc 0.9.

Влучає усі незаписані зміни в об’єкті Weblate так, щоб дані збігалися із даними у віддаленому репозиторії (переклад, складник або проєкт).

repo

Показує стан у репозиторії для вказаного об’єкта Weblate (перекладу, складника або проєкту).

stats

Показує докладну статистику щодо вказаного об’єкта Weblate (перекладу, складника або проєкту).

lock-status

Нове в версії 0.5: Підтримку передбачено з версії wlc 0.5.

Показує стан блокування.

lock

Нове в версії 0.5: Підтримку передбачено з версії wlc 0.5.

Блокує складник від подальшого перекладу на Weblate.

unlock

Нове в версії 0.5: Підтримку передбачено з версії wlc 0.5.

Розблоковує переклад складника Weblate.

changes

Нове в версії 0.7: Підтримку передбачено з версії wlc 0.7 і версії Weblate 2.10.

Показує зміни у вказаному об’єкті.

download

Нове в версії 0.7: Підтримку передбачено з версії wlc 0.7.

Отримує файл перекладу.

--convert

Перетворює формат файла. Якщо формат файла не вказано, перетворення на сервері не відбуватиметься, а файл буде отримано у форматі, у якому він зберігається у репозиторії.

--output

Вказує файл для зберігання виведених даних. Якщо файл не вказано, дані буде виведено до стандартного виведення (stdout).

upload

Нове в версії 0.9: Підтримку передбачено з версії wlc 0.9.

Вивантажує файл перекладу.

--overwrite

Перезаписати наявні переклади під час вивантаження.

--input

Файл, з якого читатимуться дані. Якщо не вказано, дані буде прочитано зі stdin.

--method

Спосіб вивантаження, яким слід скористатися. Див. Способи імпортування.

--fuzzy

Обробка неточних (позначених для редагування) перекладів (empty, process, approve)

--author-name

Ім’я автора, щоб перевизначити ім’я із запису поточного користувача системи

--author-email

Адреса електронної пошти автора, щоб перевизначити дані із запису користувача системи

Підказка

Докладніші відомості щодо виклику окремих команд можна отримати за допомогою параметра --help. Приклад: wlc ls --help.

Файли налаштувань

.weblate, .weblate.ini, weblate.ini

Файл налаштувань окремого проєкту

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

Файл налаштувань користувача у Windows.

~/.config/weblate

Файл налаштувань користувача

/etc/xdg/weblate

Загальносистемний файл налаштувань

У програмі реалізовано специфікацію XDG, тому ви можете скоригувати розташування файлів налаштувань за допомогою змінних середовища XDG_CONFIG_HOME і XDG_CONFIG_DIRS. У Windows пріоритетним місцем зберігання файла налаштувань є каталог APPDATA.

Вказані нижче параметри може бути налаштовано за допомогою розділу [weblate] (ви можете змінити розділ за допомогою параметра --config-section):

key

Ключ доступу до програмного інтерфейсу Weblate.

url

Адреса сервера програмного інтерфейсу, типово, http://127.0.0.1:8000/api/.

translation

Шлях до типового перекладу — складника або проєкту.

Файл налаштувань є файлом формату INI. Приклад:

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

У розділі [keys] можна зберігати додаткові ключі до програмного інтерфейсу:

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

Це надасть вам змогу зберігати ключі у ваших особистих параметрах, використовуючи налаштування з .weblate у репозиторії системи керування версіями так, щоб wlc було відомо, з яким сервером слід працювати.

Приклади

Вивести версію поточної програми:

$ wlc version
version: 0.1

Список усіх проєктів:

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

Вивантажити файл перекладу:

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

Ви також можете позначити проєкт, з яким має працювати wlc:

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

З цими налаштуваннями доволі просто надсилати зміни з черги у поточному проєкті:

$ wlc commit