Клиент Weblate¶

Установка¶

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 use this wlc as a Python module, see wlc.

Использование Docker¶

Клиент Weblate также доступен в виде образа Docker.

Этот образ публикуется на Docker Hub: https://hub.docker.com/r/weblate/wlc

Установка:

docker pull weblate/wlc

Контейнер Docker использует настройки по умолчанию Weblate и соединяется с API, развёрнутом на локальной машине. 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

Начало работы¶

The wlc configuration is stored in ~/.config/weblate (see Файлы настроек for other locations), please create it to match your environment:

[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]

Какая операция должна быть выполнена на самом деле указывает параметр command.

Описание¶

Клиент Weblate — это библиотека Python и инструмент командной строки для удалённого управления Weblate с помощью его REST API Weblate. Инструмент командной строки может быть вызван как wlc и встроен в wlc.

Аргументы¶

Программа принимает следующие аргументы, определяющие формат вывода или то, какой надо использовать экземпляр Weblate’а. Они должны быть введены до какой-либо команды.

--format {csv,json,text,html}¶: Определяет формат вывода.

--url URL¶: Задаёт URL-адрес API. Переопределяет любое значение, найденное в файле настроек, смотрите раздел Файлы настроек. URL-адрес должен заканчиваться на /api/, например, https://hosted.weblate.org/api/.

--key KEY¶: Задаёт пользовательский ключ API. Переопределяет любое значение из файла настроек, смотрите раздел Файлы настроек. Свой ключ вы можете найти в своём профиле на 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¶: Задаёт файл, в который нужно сохранить файл перевода, если не указан, он будет распечатан в стандартный поток вывода.

upload¶

Добавлено в версии 0.9: Поддерживается с версии wlc 0.9.

Загрузить файл перевода.

--overwrite¶: Перезаписывать существующие переводы во время загрузки.

--input¶: Файл, из которого читается содержимое, если не указан, чтение будет производиться со стандартного потока ввода.

--method¶: Используемый метод загрузки, смотрите Способы импорта.

--fuzzy¶: Что делать с неточными, отмеченными на правку, переводами (пусто, process или approve)

--author-name¶: Имя автора, для замены авторизованного в данный момент пользователя

--author-email¶: Электронная почта автора для переопределения текущей авторизации пользователя

Подсказка

Более подробную информацию по выполнению конкретных команд можно получить с помощью параметра --help, например, wlc ls --help.

Файлы настроек¶

.weblate, .weblate.ini, weblate.ini: Configuration file placed in the project directory.
C:\Users\NAME\AppData\Roaming\weblate.ini: User configuration file on Windows in the roamed profile.
C:\Users\NAME\AppData\Local\weblate.ini: User configuration file on Windows in the local profile.
~/.config/weblate: User configuration file.
/etc/xdg/weblate: System wide 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.

Можно настроить следующие параметры, находящиеся в разделе [weblate] (изменить этот раздел вы можете ключом командной строки --config-section):

key: Ключ API для доступа к Weblate.

url: Адрес API сервера, по умолчанию установлен http://127.0.0.1:8000/api/.

translation: Путь к переводу по умолчанию — компоненту или проекту.

Файл настроек является INI-файлом, например:

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

Дополнительно ключи API могут быть сохранены в разделе [keys]:

[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.

Примеры¶

Печать текущей версии программы:

$ 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

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/

При такой настройке закоммитить отложенные изменения в текущем проекте проще простого:

$ wlc commit