wlc


Namewlc JSON
Version 1.15 PyPI version JSON
download
home_pageNone
SummaryA command-line utility for Weblate, translation tool with tight version control integration
upload_time2024-09-03 08:47:39
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseGPL-3.0-or-later
keywords i18n l10n gettext git mercurial translate
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            <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).

[![Website](https://img.shields.io/badge/website-weblate.org-blue.svg)](https://weblate.org/)
[![Translation status](https://hosted.weblate.org/widgets/weblate/-/svg-badge.svg)](https://hosted.weblate.org/engage/weblate/?utm_source=widget)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/552/badge)](https://bestpractices.coreinfrastructure.org/projects/552)
[![PyPI package](https://img.shields.io/pypi/v/wlc.svg)](https://pypi.org/project/wlc/)
[![Documenation](https://readthedocs.org/projects/weblate/badge/)](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.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "wlc",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "i18n, l10n, gettext, git, mercurial, translate",
    "author": null,
    "author_email": "Michal \u010ciha\u0159 <michal@cihar.com>",
    "download_url": "https://files.pythonhosted.org/packages/24/57/0b63c58996dce7873c3f3185930acdd19871e4807fde02118d220a86868c/wlc-1.15.tar.gz",
    "platform": "any",
    "description": "<a href=\"https://weblate.org/\"><img alt=\"Weblate\" src=\"https://s.weblate.org/cdn/Logo-Darktext-borders.png\" height=\"80px\" /></a>\n\n**Weblate is libre software web-based continuous localization system,\nused by over 2500 libre projects and companies in more than 165 countries.**\n\n# wlc\n\nwlc is a [Weblate](https://weblate.org/) command-line client using [Weblate's REST API](https://docs.weblate.org/en/latest/api.html).\n\n[![Website](https://img.shields.io/badge/website-weblate.org-blue.svg)](https://weblate.org/)\n[![Translation status](https://hosted.weblate.org/widgets/weblate/-/svg-badge.svg)](https://hosted.weblate.org/engage/weblate/?utm_source=widget)\n[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/552/badge)](https://bestpractices.coreinfrastructure.org/projects/552)\n[![PyPI package](https://img.shields.io/pypi/v/wlc.svg)](https://pypi.org/project/wlc/)\n[![Documenation](https://readthedocs.org/projects/weblate/badge/)](https://docs.weblate.org/en/latest/wlc.html)\n\n## PIP Installation\n\nInstall using pip:\n\n```console\npip3 install wlc\n```\n\nSources are available at <https://github.com/WeblateOrg/wlc>.\n\n## Usage\n\nPlease see [Weblate documentation](https://docs.weblate.org/en/latest/wlc.html) for more complete documentation.\n\nCommand-line usage:\n\n```console\nwlc list-projects\nwlc list-components\nwlc list-translations\nwlc list-languages\nwlc show\nwlc ls\nwlc commit\nwlc push\nwlc pull\nwlc repo\nwlc stats\nwlc lock\nwlc unlock\nwlc lock-status\nwlc download\nwlc upload\n```\n\nConfiguration is stored in `~/.config/weblate`. The key/values (`retries`,\n`timeout`, `method_whitelist`, `backoff_factor`, `status_forcelist`) are closely\ncoupled with the [urllib3 parameters](https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html) and allows the user to configure request\nparameters.\n\n```ini\n[weblate]\nurl = https://hosted.weblate.org/api/\nretries = 3\nmethod_whitelist = PUT,POST,GET\nbackoff_factor = 0.2\nstatus_forcelist = 429,500,502,503,504\ntimeout = 30\n\n[keys]\nhttps://hosted.weblate.org/api/ = APIKEY\n```\n\n## Docker image\n\nThe image is published on [Docker Hub](https://hub.docker.com/r/weblate/wlc).\n\nBuilding locally:\n\n```console\ndocker build -t weblate/wlc .\n```\n\nDetailed documentation is available in [Weblate documentation](https://docs.weblate.org/en/latest/wlc.html#docker-wlc).\n\n## Docker hub tags\n\nYou can use following tags on Docker hub:\n\n| Tag name | Description                                                                       | Use case                                        |\n| -------- | --------------------------------------------------------------------------------- | ----------------------------------------------- |\n| `latest` | wlc stable release, matches latest tagged release                                 | Rolling updates in a production environment     |\n| `edge`   | wlc development                                                                   | Staging environment                             |\n| version  | wlc stable release, see [weblate/wlc](https://hub.docker.com/r/weblate/wlc/tags/) | Well defined deploy in a production environment |\n\nEvery image is tested by our CI before it gets published, so even the `bleeding` version should be quite safe to use.\n\n## Contributing\n\nContributions are welcome! See [documentation](https://docs.weblate.org/en/latest/contributing/modules.html) for more information.\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "A command-line utility for Weblate, translation tool with tight version control integration",
    "version": "1.15",
    "project_urls": {
        "Documentation": "https://docs.weblate.org/",
        "Download": "https://github.com/WeblateOrg/wlc",
        "Funding": "https://weblate.org/donate/",
        "Homepage": "https://weblate.org/",
        "Issue Tracker": "https://github.com/WeblateOrg/wlc/issues",
        "Source Code": "https://github.com/WeblateOrg/wlc",
        "Twitter": "https://twitter.com/WeblateOrg"
    },
    "split_keywords": [
        "i18n",
        " l10n",
        " gettext",
        " git",
        " mercurial",
        " translate"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c4365b885ce5d3c4c6c1b7ffcac0b988802713725a246cb40dec424d7792c4f8",
                "md5": "92738a2d6187045ee119852d08e3012f",
                "sha256": "0cd0b54efdb5b92f608666266552d5e5170be9c1daf4cc352a7106bf358f758a"
            },
            "downloads": -1,
            "filename": "wlc-1.15-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "92738a2d6187045ee119852d08e3012f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 89612,
            "upload_time": "2024-09-03T08:47:37",
            "upload_time_iso_8601": "2024-09-03T08:47:37.561887Z",
            "url": "https://files.pythonhosted.org/packages/c4/36/5b885ce5d3c4c6c1b7ffcac0b988802713725a246cb40dec424d7792c4f8/wlc-1.15-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "24570b63c58996dce7873c3f3185930acdd19871e4807fde02118d220a86868c",
                "md5": "0fbfb91e1be26059ea1de06f3f7f32d4",
                "sha256": "d13f1c32ae4caeffd8828e817d8868dec8c5baef1d619c9432d25ce6069bb86e"
            },
            "downloads": -1,
            "filename": "wlc-1.15.tar.gz",
            "has_sig": false,
            "md5_digest": "0fbfb91e1be26059ea1de06f3f7f32d4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 78183,
            "upload_time": "2024-09-03T08:47:39",
            "upload_time_iso_8601": "2024-09-03T08:47:39.287027Z",
            "url": "https://files.pythonhosted.org/packages/24/57/0b63c58996dce7873c3f3185930acdd19871e4807fde02118d220a86868c/wlc-1.15.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-03 08:47:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "WeblateOrg",
    "github_project": "wlc",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "wlc"
}
        
Elapsed time: 0.35727s