perceval-mozilla


Nameperceval-mozilla JSON
Version 0.4.3 PyPI version JSON
download
home_pagehttps://chaoss.github.io/grimoirelab/
SummaryBundle of Perceval backends for Mozilla ecosystem.
upload_time2024-03-27 12:18:34
maintainerNone
docs_urlNone
authorGrimoireLab Developers
requires_python<4.0,>=3.8
licenseGPL-3.0+
keywords development grimoirelab
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # perceval-mozilla [![Build Status](https://github.com/chaoss/grimoirelab-perceval-mozilla/workflows/tests/badge.svg)](https://github.com/chaoss/grimoirelab-perceval-mozilla/actions?query=workflow:tests+branch:master+event:push) [![Coverage Status](https://img.shields.io/coveralls/chaoss/grimoirelab-perceval-mozilla.svg)](https://coveralls.io/r/chaoss/grimoirelab-perceval-mozilla?branch=master) [![PyPI version](https://badge.fury.io/py/perceval-mozilla.svg)](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/18/e6/c3134fe564fecdb8a76cbb1f6843c4b2a4755c2ef79da4180a6a789eb7e6/perceval_mozilla-0.4.3.tar.gz",
    "platform": null,
    "description": "# perceval-mozilla [![Build Status](https://github.com/chaoss/grimoirelab-perceval-mozilla/workflows/tests/badge.svg)](https://github.com/chaoss/grimoirelab-perceval-mozilla/actions?query=workflow:tests+branch:master+event:push) [![Coverage Status](https://img.shields.io/coveralls/chaoss/grimoirelab-perceval-mozilla.svg)](https://coveralls.io/r/chaoss/grimoirelab-perceval-mozilla?branch=master) [![PyPI version](https://badge.fury.io/py/perceval-mozilla.svg)](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": "0.4.3",
    "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": "df41c1d3cbd4a3000dc45649f89a8714a421f793897b59b094b863bd7511ffe3",
                "md5": "3b4e326d83dac6ec8510fb0452c44729",
                "sha256": "9642614539b1f358f392c909cd28de7025118740826aa5529dede4c8d24c29f2"
            },
            "downloads": -1,
            "filename": "perceval_mozilla-0.4.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3b4e326d83dac6ec8510fb0452c44729",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 29784,
            "upload_time": "2024-03-27T12:18:32",
            "upload_time_iso_8601": "2024-03-27T12:18:32.871836Z",
            "url": "https://files.pythonhosted.org/packages/df/41/c1d3cbd4a3000dc45649f89a8714a421f793897b59b094b863bd7511ffe3/perceval_mozilla-0.4.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "18e6c3134fe564fecdb8a76cbb1f6843c4b2a4755c2ef79da4180a6a789eb7e6",
                "md5": "97355d4aa55735d9cf85838be208f661",
                "sha256": "d0063d410bf72af5833b0c98c20c8c4e2f83bdc61adb425fa6af0ed1042e2abb"
            },
            "downloads": -1,
            "filename": "perceval_mozilla-0.4.3.tar.gz",
            "has_sig": false,
            "md5_digest": "97355d4aa55735d9cf85838be208f661",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 150900,
            "upload_time": "2024-03-27T12:18:34",
            "upload_time_iso_8601": "2024-03-27T12:18:34.520097Z",
            "url": "https://files.pythonhosted.org/packages/18/e6/c3134fe564fecdb8a76cbb1f6843c4b2a4755c2ef79da4180a6a789eb7e6/perceval_mozilla-0.4.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-27 12:18:34",
    "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"
}
        
Elapsed time: 0.23977s