https://github.com/weblateorg/wlc
Weblate command line client
https://github.com/weblateorg/wlc
command-line-tool hacktoberfest i18n internationalization python3 weblate
Last synced: 5 months ago
JSON representation
Weblate command line client
- Host: GitHub
- URL: https://github.com/weblateorg/wlc
- Owner: WeblateOrg
- License: gpl-3.0
- Created: 2016-03-22T16:12:47.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2025-07-03T20:41:36.000Z (12 months ago)
- Last Synced: 2025-07-03T21:34:31.810Z (12 months ago)
- Topics: command-line-tool, hacktoberfest, i18n, internationalization, python3, weblate
- Language: Python
- Homepage: https://weblate.org/
- Size: 1.11 MB
- Stars: 37
- Watchers: 7
- Forks: 20
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.rst
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
**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 .
## 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.
