# perceval-pontoon
Perceval backend for Pontoon.
## Backends
The backend currently managed by this package support the next repository:
* Pontoon
## Requirements
* Python >= 3.8
You will also need some other libraries for running the tool, you can find the
whole list of dependencies in [pyproject.toml](pyproject.toml) file.
## Installation
There are several ways to install perceval-pontoon on your system: packages or source
code using Poetry or pip.
### PyPI
perceval-pontoon can be installed using pip, a tool for installing Python packages.
To do it, run the next command:
```
$ pip install perceval-pontoon
```
### Source code
To install from the source code you will need to clone the repository first:
```
$ git clone https://github.com/bitergia-analytics/grimoirelab-perceval-pontoon
$ cd grimoirelab-perceval-pontoon
```
Then use pip or Poetry to install the package along with its dependencies.
#### Pip
To install the package from local directory run the following command:
```
$ pip install .
```
In case you are a developer, you should install perceval-pontoon in editable mode:
```
$ pip install -e .
```
#### Poetry
We use [poetry](https://python-poetry.org/) for dependency management and
packaging. You can install it following its [documentation](https://python-poetry.org/docs/#installation).
Once you have installed it, you can install perceval-pontoon and the dependencies in
a project isolated environment using:
```
$ poetry install
```
To spaw a new shell within the virtual environment use:
```
$ poetry shell
```
## Example
### Pontoon
#### Translations
To download the entities and translations provided by users from a Pontoon backend
you need the URL of the server and the locales you want to obtain.
Run perceval with the Pontoon URL and the locale to fetch the entities and
translations. For example:
```
$ perceval pontoon "https://pontoon.example.com" es
```
You can also specify from what date you want to obtain the translation suggestion
with `--from-date` and `--to-date`.
#### Locales
To obtain the list of locales available in a server, run Perceval in the following way:
```
$ perceval pontoon "https://pontoon.example.com" --category locale
```
## License
Licensed under GNU General Public License (GPL), version 3 or later.
Raw data
{
"_id": null,
"home_page": "https://chaoss.github.io/grimoirelab/",
"name": "perceval-pontoon",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "development, grimoirelab",
"author": "Bitergia Developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/15/0f/c469bcf70fd06654ad0d77240eff80535eb529240a5945d0cd0a8f23ccdc/perceval_pontoon-0.1.5.tar.gz",
"platform": null,
"description": "# perceval-pontoon\n\nPerceval backend for Pontoon.\n\n## Backends\n\nThe backend currently managed by this package support the next repository:\n\n* Pontoon\n\n## Requirements\n\n * Python >= 3.8\n\nYou will also need some other libraries for running the tool, you can find the\nwhole list of dependencies in [pyproject.toml](pyproject.toml) file.\n\n## Installation\n\nThere are several ways to install perceval-pontoon on your system: packages or source \ncode using Poetry or pip.\n\n### PyPI\n\nperceval-pontoon can be installed using pip, a tool for installing Python packages. \nTo do it, run the next command:\n```\n$ pip install perceval-pontoon\n```\n\n### Source code\n\nTo install from the source code you will need to clone the repository first:\n```\n$ git clone https://github.com/bitergia-analytics/grimoirelab-perceval-pontoon\n$ cd grimoirelab-perceval-pontoon\n```\n\nThen use pip or Poetry to install the package along with its dependencies.\n\n#### Pip\nTo install the package from local directory run the following command:\n```\n$ pip install .\n```\nIn case you are a developer, you should install perceval-pontoon in editable mode:\n```\n$ pip install -e .\n```\n\n#### Poetry\nWe use [poetry](https://python-poetry.org/) for dependency management and \npackaging. You can install it following its [documentation](https://python-poetry.org/docs/#installation).\nOnce you have installed it, you can install perceval-pontoon and the dependencies in \na project isolated environment using:\n```\n$ poetry install\n```\nTo spaw a new shell within the virtual environment use:\n```\n$ poetry shell\n```\n\n## Example\n\n### Pontoon\n\n#### Translations\n\nTo download the entities and translations provided by users from a Pontoon backend\nyou need the URL of the server and the locales you want to obtain.\n\nRun perceval with the Pontoon URL and the locale to fetch the entities and\ntranslations. For example:\n\n```\n$ perceval pontoon \"https://pontoon.example.com\" es\n```\n\nYou can also specify from what date you want to obtain the translation suggestion\nwith `--from-date` and `--to-date`.\n\n#### Locales\n\nTo obtain the list of locales available in a server, run Perceval in the following way:\n\n```\n$ perceval pontoon \"https://pontoon.example.com\" --category locale\n```\n\n## License\n\nLicensed under GNU General Public License (GPL), version 3 or later.\n",
"bugtrack_url": null,
"license": "GPL-3.0+",
"summary": "Perceval backend for Pontoon",
"version": "0.1.5",
"project_urls": {
"Bug Tracker": "https://github.com/bitergia-analytics/grimoirelab-perceval-pontoon/issues",
"Homepage": "https://chaoss.github.io/grimoirelab/",
"Repository": "https://github.com/bitergia-analytics/grimoirelab-perceval-pontoon"
},
"split_keywords": [
"development",
" grimoirelab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d422a893a0a5f77b5bbb2f34ba8d4b8b7f61ac4f321a47f88079a7efad549e4d",
"md5": "1b1877bc069e9a401ba57ec134dc3ea3",
"sha256": "2e42c85141ddb9c0f8223cedefcecdf01fc1da63581db03a6ffb1da03e2ffbca"
},
"downloads": -1,
"filename": "perceval_pontoon-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1b1877bc069e9a401ba57ec134dc3ea3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 18197,
"upload_time": "2024-05-09T13:03:01",
"upload_time_iso_8601": "2024-05-09T13:03:01.746009Z",
"url": "https://files.pythonhosted.org/packages/d4/22/a893a0a5f77b5bbb2f34ba8d4b8b7f61ac4f321a47f88079a7efad549e4d/perceval_pontoon-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "150fc469bcf70fd06654ad0d77240eff80535eb529240a5945d0cd0a8f23ccdc",
"md5": "dbe092484d32a5b04ca62ef04aa73754",
"sha256": "530228ea24fc335308bda9c5d67728345681ba2f5f79e5ad8100528c0175a1a5"
},
"downloads": -1,
"filename": "perceval_pontoon-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "dbe092484d32a5b04ca62ef04aa73754",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 25458,
"upload_time": "2024-05-09T13:03:02",
"upload_time_iso_8601": "2024-05-09T13:03:02.973882Z",
"url": "https://files.pythonhosted.org/packages/15/0f/c469bcf70fd06654ad0d77240eff80535eb529240a5945d0cd0a8f23ccdc/perceval_pontoon-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-09 13:03:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bitergia-analytics",
"github_project": "grimoirelab-perceval-pontoon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "perceval-pontoon"
}
JSON
