Weblate Client¶
Nuevo en la versión 2.7: The wlc utility is fully supported since Weblate 2.7. If you are using an older version some incompatibilities with the API might occur.
Installation¶
The Weblate Client is shipped separately and includes the Python module.
You need to install wlc
:, wlc to use these.
pip3 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
built on wlc
.
Global options¶
The program accepts the 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 examplehttps://hosted.weblate.org/api/
.
Subcommands¶
Currently the 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.
-
show
¶
Shows Weblate object (translation, component or project).
-
ls
¶
Lists Weblate object (translation, component or project).
-
commit
¶
Commits changes in Weblate object (translation, component or project).
-
pull
¶
Pulls remote repository changes into Weblate object (translation, component or project).
-
push
¶
Pushes changes in Weblate object into remote repository (translation, component or project).
-
reset
¶
Nuevo en la versión 0.7: Supported since wlc 0.7.
Resets changes in Weblate object to match remote repository (translation, component or project).
-
repo
¶
Displays repository status for given Weblate object (translation, component or project).
-
statistics
¶
Displays detailed statistics for given Weblate object (translation, component or project).
-
lock-status
¶
Nuevo en la versión 0.5: Supported since wlc 0.5.
Displays lock status.
-
lock
¶
Nuevo en la versión 0.5: Supported since wlc 0.5.
Locks compontent from translating in Weblate.
-
unlock
¶
Nuevo en la versión 0.5: Supported since wlc 0.5.
Unlocks compontent from translating in Weblate.
-
changes
¶
Nuevo en la versión 0.7: Supported since wlc 0.7 and Weblate 2.10.
Displays changes for given object.
Files¶
.weblate
- Per project configuration file
~/.config/weblate
- User configuration file
/etc/xdg/weblate
- 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 [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 of default translation, component or project.
The configuration file is INI file, for example:
[weblate]
url = https://hosted.weblate.org/api/
key = APIKEY
translation = weblate/master
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 having
.weblate
configuration in the VCS repository so that wlc knows to which
server it should talk.
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: https://weblate.org/
web_url: http://example.com/projects/hello/
You can also let wlc know current project and it will then operate on it:
$ cat .weblate
[weblate]
url = https://hosted.weblate.org/api/
translation = weblate/master
$ wlc show
branch: master
file_format: po
filemask: weblate/locale/*/LC_MESSAGES/django.po
git_export: https://hosted.weblate.org/git/weblate/master/
license: GPL-3.0+
license_url: https://spdx.org/licenses/GPL-3.0+
name: master
new_base: weblate/locale/django.pot
project: weblate
repo: git://github.com/WeblateOrg/weblate.git
slug: master
template:
url: https://hosted.weblate.org/api/components/weblate/master/
vcs: git
web_url: https://hosted.weblate.org/projects/weblate/master/
With such setup it is easy to commit pending changes in current project:
$ wlc commit