# perceval-mozilla [](https://github.com/chaoss/grimoirelab-perceval-mozilla/actions?query=workflow:tests+branch:master+event:push) [](https://coveralls.io/r/chaoss/grimoirelab-perceval-mozilla?branch=master) [](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.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-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.8",
"maintainer_email": null,
"keywords": "development, grimoirelab",
"author": "GrimoireLab Developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/0e/08/afa7357e59949c65674e6d0c152f9c4587428e737ce81d0eb119e46c8f69/perceval_mozilla-1.0.0.tar.gz",
"platform": null,
"description": "# perceval-mozilla [](https://github.com/chaoss/grimoirelab-perceval-mozilla/actions?query=workflow:tests+branch:master+event:push) [](https://coveralls.io/r/chaoss/grimoirelab-perceval-mozilla?branch=master) [](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.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-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.0",
"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": "db233bc812e2abccae1f9da089e68020e984eb64ee3861ccfc1fa1e2aa918505",
"md5": "e093d9e5eba975e846d6f3dc7caa651f",
"sha256": "66591be364d59278f591e08b548194cb4709b04f22755196c2af7df7239b251f"
},
"downloads": -1,
"filename": "perceval_mozilla-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e093d9e5eba975e846d6f3dc7caa651f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 29788,
"upload_time": "2024-04-13T07:31:44",
"upload_time_iso_8601": "2024-04-13T07:31:44.114686Z",
"url": "https://files.pythonhosted.org/packages/db/23/3bc812e2abccae1f9da089e68020e984eb64ee3861ccfc1fa1e2aa918505/perceval_mozilla-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0e08afa7357e59949c65674e6d0c152f9c4587428e737ce81d0eb119e46c8f69",
"md5": "119971d3ea0feb39514a019fd88fa1ba",
"sha256": "6dbe74c51738d7468c285cbd66ebf9326dc34b5db4a7332ccf3e5a7cbdb09014"
},
"downloads": -1,
"filename": "perceval_mozilla-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "119971d3ea0feb39514a019fd88fa1ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 150945,
"upload_time": "2024-04-13T07:31:45",
"upload_time_iso_8601": "2024-04-13T07:31:45.502963Z",
"url": "https://files.pythonhosted.org/packages/0e/08/afa7357e59949c65674e6d0c152f9c4587428e737ce81d0eb119e46c8f69/perceval_mozilla-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-13 07:31:45",
"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
