Weblate Client¶

Instalation¶

The Weblate Client is shipped separately, you need to install wlc to have it, it also includes Python module wlc:

pip install wlc

Synopsis¶

wlc [parameter] <command> [options]

Commands actually indicate which operation should be performed.

Description¶

Weblate Client is Python library and command line utility to manage Weblate remotely using Weblate’s Web API. The command line utility can be invoked as wlc and is build on wlc.

Global options¶

The program accepts following global options, which must be entered before subcommand.

--format {csv,json,text,html}¶: Specify output format.

--url URL¶: Specify API URL. Overrides value from configuration file, see Files. The URL should end with /api/, for example https://hosted.weblate.org/api/.

--key KEY¶: Specify API user key to use. Overrides value from configuration file, see Files. You can figure out your key in your profile in Weblate.

--config PATH¶: Override path to configuration file, see Files.

--config-section SECTION¶: Override section to use in configuration file, see Files.

Subcommands¶

Currently following subcommands are available:

version¶: Prints current version.

list-languages¶: List used languages in Weblate.

list-projects¶: List projects in Weblate.

list-components¶: List components in Weblate.

list-translations¶: List translations in Weblate.

Files¶

~/.config/wlc: User configuration file
/etc/xdg/wlc: Global configration file

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

Following settings can be configured in the [wlc] 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/.

The configuration file is INI file, for example:

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

Examples¶

Print current program version:

$ wlc version
version: 0.1

List all projects:

$ wlc list-projects
name: Hello
slug: hello
source_language: en
url: http://example.com/api/projects/hello/
web: http://weblate.org/
web_url: http://example.com/projects/hello/