# perceval-mozilla [](https://github.com/chaoss/grimoirelab-perceval-mozilla/actions?query=workflow:tests+branch:main+event:push) [](https://coveralls.io/r/chaoss/grimoirelab-perceval-mozilla?branch=main) [](https://badge.fury.io/py/perceval-mozilla)
Bundle of Perceval backends for Mozilla ecosystem.
## Backends
The backends currently managed by this package support the next repositories:
* Crates
* Kitsune
* MozillaClub
* ReMo
## Requirements
* Python >= 3.9
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-mozilla on your system: packages or source
code using Poetry or pip.
### PyPI
perceval-mozilla can be installed using pip, a tool for installing Python packages.
To do it, run the next command:
```
$ pip install perceval-mozilla
```
### Source code
To install from the source code you will need to clone the repository first:
```
$ git clone https://github.com/chaoss/grimoirelab-perceval-mozilla
$ cd grimoirelab-perceval-mozilla
```
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-mozilla 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-mozilla and the dependencies in
a project isolated environment using:
```
$ poetry install
```
To spaw a new shell within the virtual environment use:
```
$ poetry shell
```
## Examples
### Crates
```
$ perceval crates
```
### Kitsune
```
$ perceval kitsune --offset 373990
```
### Mozilla Club Events
```
$ perceval mozillaclub
```
### ReMo
```
$ perceval remo
```
## 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-mozilla",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "development, grimoirelab",
"author": "GrimoireLab Developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/60/b7/0cc2cad9d242370bd782b496d55d1e596ad3808ebe641e1527c1eb930d57/perceval_mozilla-1.0.11.tar.gz",
"platform": null,
"description": "# perceval-mozilla [](https://github.com/chaoss/grimoirelab-perceval-mozilla/actions?query=workflow:tests+branch:main+event:push) [](https://coveralls.io/r/chaoss/grimoirelab-perceval-mozilla?branch=main) [](https://badge.fury.io/py/perceval-mozilla)\n\nBundle of Perceval backends for Mozilla ecosystem.\n\n## Backends\n\nThe backends currently managed by this package support the next repositories:\n\n* Crates\n* Kitsune\n* MozillaClub\n* ReMo\n\n## Requirements\n\n * Python >= 3.9\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-mozilla on your system: packages or source \ncode using Poetry or pip.\n\n### PyPI\n\nperceval-mozilla can be installed using pip, a tool for installing Python packages. \nTo do it, run the next command:\n```\n$ pip install perceval-mozilla\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/chaoss/grimoirelab-perceval-mozilla\n$ cd grimoirelab-perceval-mozilla\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-mozilla 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-mozilla 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## Examples\n\n### Crates\n\n```\n$ perceval crates\n```\n\n### Kitsune\n\n```\n$ perceval kitsune --offset 373990\n```\n\n### Mozilla Club Events\n\n```\n$ perceval mozillaclub\n```\n\n### ReMo\n```\n$ perceval remo\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": "Bundle of Perceval backends for Mozilla ecosystem.",
"version": "1.0.11",
"project_urls": {
"Bug Tracker": "https://github.com/chaoss/grimoirelab-perceval-mozilla/issues",
"Homepage": "https://chaoss.github.io/grimoirelab/",
"Repository": "https://github.com/chaoss/grimoirelab-perceval-mozilla"
},
"split_keywords": [
"development",
" grimoirelab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c51fbe71373997d2ab588f34fb761f5e2063b5894e6588809a25cf253dcdd802",
"md5": "e444f159939f74b2f23fd9c5bc1168f9",
"sha256": "0b3b9adeb6767d2a8232276ecad5f13837e85b01da81e9679fde1a41f1774bb1"
},
"downloads": -1,
"filename": "perceval_mozilla-1.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e444f159939f74b2f23fd9c5bc1168f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 29530,
"upload_time": "2025-01-15T12:02:48",
"upload_time_iso_8601": "2025-01-15T12:02:48.555092Z",
"url": "https://files.pythonhosted.org/packages/c5/1f/be71373997d2ab588f34fb761f5e2063b5894e6588809a25cf253dcdd802/perceval_mozilla-1.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "60b70cc2cad9d242370bd782b496d55d1e596ad3808ebe641e1527c1eb930d57",
"md5": "d4a6f6c319603e3f165c020998157856",
"sha256": "ac53a6dc686cecdaab6965ab315f8e16854bc503d057e7c8c55ff98111e53705"
},
"downloads": -1,
"filename": "perceval_mozilla-1.0.11.tar.gz",
"has_sig": false,
"md5_digest": "d4a6f6c319603e3f165c020998157856",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 151179,
"upload_time": "2025-01-15T12:02:49",
"upload_time_iso_8601": "2025-01-15T12:02:49.735217Z",
"url": "https://files.pythonhosted.org/packages/60/b7/0cc2cad9d242370bd782b496d55d1e596ad3808ebe641e1527c1eb930d57/perceval_mozilla-1.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-15 12:02:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chaoss",
"github_project": "grimoirelab-perceval-mozilla",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "perceval-mozilla"
}
JSON
