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 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 for dependency management and packaging. You can install it following its documentation. 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.