1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
Metadata-Version: 2.1
Name: wlc
Version: 1.15
Summary: A command-line utility for Weblate, translation tool with tight version control integration
Author-email: Michal Čihař <michal@cihar.com>
License: GPL-3.0-or-later
Project-URL: Documentation, https://docs.weblate.org/
Project-URL: Download, https://github.com/WeblateOrg/wlc
Project-URL: Funding, https://weblate.org/donate/
Project-URL: Homepage, https://weblate.org/
Project-URL: Issue Tracker, https://github.com/WeblateOrg/wlc/issues
Project-URL: Source Code, https://github.com/WeblateOrg/wlc
Project-URL: Twitter, https://twitter.com/WeblateOrg
Keywords: i18n,l10n,gettext,git,mercurial,translate
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Internationalization
Classifier: Topic :: Software Development :: Localization
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: argcomplete
Requires-Dist: python-dateutil
Requires-Dist: pyxdg
Requires-Dist: requests>=2.25.0
Requires-Dist: urllib3>=1.26
Provides-Extra: lint
Requires-Dist: pre-commit==3.8.0; extra == "lint"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: responses<0.26.0,>=0.10.1; extra == "test"
Requires-Dist: build==1.2.1; extra == "test"
Requires-Dist: twine==5.1.1; extra == "test"
<a href="https://weblate.org/"><img alt="Weblate" src="https://s.weblate.org/cdn/Logo-Darktext-borders.png" height="80px" /></a>
**Weblate is libre software web-based continuous localization system,
used by over 2500 libre projects and companies in more than 165 countries.**
# wlc
wlc is a [Weblate](https://weblate.org/) command-line client using [Weblate's REST API](https://docs.weblate.org/en/latest/api.html).
[](https://weblate.org/)
[](https://hosted.weblate.org/engage/weblate/?utm_source=widget)
[](https://bestpractices.coreinfrastructure.org/projects/552)
[](https://pypi.org/project/wlc/)
[](https://docs.weblate.org/en/latest/wlc.html)
## PIP Installation
Install using pip:
```console
pip3 install wlc
```
Sources are available at <https://github.com/WeblateOrg/wlc>.
## Usage
Please see [Weblate documentation](https://docs.weblate.org/en/latest/wlc.html) for more complete documentation.
Command-line usage:
```console
wlc list-projects
wlc list-components
wlc list-translations
wlc list-languages
wlc show
wlc ls
wlc commit
wlc push
wlc pull
wlc repo
wlc stats
wlc lock
wlc unlock
wlc lock-status
wlc download
wlc upload
```
Configuration is stored in `~/.config/weblate`. The key/values (`retries`,
`timeout`, `method_whitelist`, `backoff_factor`, `status_forcelist`) are closely
coupled with the [urllib3 parameters](https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html) and allows the user to configure request
parameters.
```ini
[weblate]
url = https://hosted.weblate.org/api/
retries = 3
method_whitelist = PUT,POST,GET
backoff_factor = 0.2
status_forcelist = 429,500,502,503,504
timeout = 30
[keys]
https://hosted.weblate.org/api/ = APIKEY
```
## Docker image
The image is published on [Docker Hub](https://hub.docker.com/r/weblate/wlc).
Building locally:
```console
docker build -t weblate/wlc .
```
Detailed documentation is available in [Weblate documentation](https://docs.weblate.org/en/latest/wlc.html#docker-wlc).
## Docker hub tags
You can use following tags on Docker hub:
| Tag name | Description | Use case |
| -------- | --------------------------------------------------------------------------------- | ----------------------------------------------- |
| `latest` | wlc stable release, matches latest tagged release | Rolling updates in a production environment |
| `edge` | wlc development | Staging environment |
| version | wlc stable release, see [weblate/wlc](https://hub.docker.com/r/weblate/wlc/tags/) | Well defined deploy in a production environment |
Every image is tested by our CI before it gets published, so even the `bleeding` version should be quite safe to use.
## Contributing
Contributions are welcome! See [documentation](https://docs.weblate.org/en/latest/contributing/modules.html) for more information.
|
