Weblate-klient¶

Installasjon¶

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

Hint

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

Docker usage¶

The Weblate Client is also available as a Docker image.

The image is published on Docker Hub: https://hub.docker.com/r/weblate/wlc

Installere:

docker pull weblate/wlc

The Docker container uses Weblate’s default settings and connects to the API deployed in localhost. The API URL and API_KEY can be configured through the arguments accepted by Weblate.

The command to launch the container uses the following syntax:

docker run --rm weblate/wlc [WLC_ARGS]

Eksempel:

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

You might want to pass your Oppsettsfiler to the Docker container, the easiest approach is to add your current directory as /home/weblate volume:

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

Kom i gang¶

The wlc configuration is stored in ~/.config/weblate (see Oppsettsfiler for other locations), please create it to match your environment:

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

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

You can then invoke commands on the default server:

wlc ls
wlc commit sandbox/hello-world

Se også

Oppsettsfiler

Sammendrag¶

wlc [arguments] <command> [options]

Commands actually indicate which operation should be performed.

Beskrivelse¶

Weblate Client is a Python library and command-line utility to manage Weblate remotely using Weblate’s REST API. The command-line utility can be invoked as wlc and is built-in on wlc.

Arguments¶

The program accepts the following arguments which define output format or which Weblate instance to use. These must be entered before any command.

--format {csv,json,text,html}¶: Angi utdataformatet.

--url URL¶: Specify the API URL. Overrides any value found in the configuration file, see Oppsettsfiler. The URL should end with /api/, for example https://hosted.weblate.org/api/.

--key KEY¶: Specify the API user key to use. Overrides any value found in the configuration file, see Oppsettsfiler. You can find your key in your profile on Weblate.

--config PATH¶: Overrides the configuration file path, see Oppsettsfiler.

--config-section SECTION¶: Overrides configuration file section in use, see Oppsettsfiler.

Commands¶

The following commands are available:

version¶: Prints the current version.

list-languages¶: Lists used languages in Weblate.

list-projects¶: Lists projects in Weblate.

list-components¶: Lists components in Weblate.

list-translations¶: Lists translations in Weblate.

show¶: Shows Weblate object (translation, component or project).

ls¶: Lists Weblate object (translation, component or project).

commit¶: Commits changes made in a Weblate object (translation, component or project).

pull¶: Pulls remote repository changes into Weblate object (translation, component or project).

push¶: Pushes Weblate object changes into remote repository (translation, component or project).

reset¶: Added in version 0.7: Supported since wlc 0.7.

Resets changes in Weblate object to match remote repository (translation, component or project).

cleanup¶: Added in version 0.9: Supported since wlc 0.9.

Removes any untracked changes in a Weblate object to match the remote repository (translation, component or project).

repo¶: Displays repository status for a given Weblate object (translation, component or project).

stats¶: Displays detailed statistics for a given Weblate object (translation, component or project).

lock-status¶: Added in version 0.5: Supported since wlc 0.5.

Viser låsestatus.

lock¶: Added in version 0.5: Supported since wlc 0.5.

Locks component from further translation in Weblate.

unlock¶: Added in version 0.5: Supported since wlc 0.5.

Unlocks translation of Weblate component.

changes¶: Added in version 0.7: Støttet siden wlc 0.7 og Weblate 2.10.

Viser endringer for et gitt objekt.

download¶

Added in version 0.7: Supported since wlc 0.7.

Laster ned en oversettelsesfil.

--convert¶: Converts file format, if unspecified no conversion happens on the server and the file is downloaded as is to the repository.

--output¶: Specifies file to save output in, if left unspecified it is printed to stdout.

upload¶

Added in version 0.9: Supported since wlc 0.9.

Laster opp en oversettelsesfil.

--overwrite¶: Overskriv eksisterende oversettelser ved opplasting.

--input¶: Fil innholdet leses fra. Hvis den levnes uspesifisert leses det fra stdin.

--method¶: Upload method to use, see Import methods.

--fuzzy¶: Fuzzy (marked for edit) strings processing (empty, process, approve)

--author-name¶: Author name, to override currently authenticated user

--author-email¶: Author e-mail, to override currently authenticated user

Hint

You can get more detailed information on invoking individual commands by passing --help, for example: wlc ls --help.

Oppsettsfiler¶

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

Following settings can be configured in the [weblate] section (you can customize this by --config-section):

key: API KEY to access Weblate.

url: API server URL, defaults to http://127.0.0.1:8000/api/.

translation: Path to the default translation - component or project.

The configuration file is an INI file, for example:

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

Additionally API keys can be 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.

Eksempler¶

Skriv ut nåværende programversjon:

$ wlc version
version: 0.1

List opp alle prosjekter:

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

Upload translation file:

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

With this setup it is easy to commit pending changes in the current project:

$ wlc commit