Perceval backend for public-inbox.
Project description
perceval-public-inbox
Perceval backend for public-inbox repositories.
Backends
The backend currently managed by this package support the next repository:
- public-inbox
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-public-inbox on your system: packages or source code using Poetry or pip.
PyPI
perceval-public-inbox can be installed using pip, a tool for installing Python packages. To do it, run the next command:
$ pip install perceval-public-inbox
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-public-inbox
$ cd grimoirelab-perceval-public-inbox
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-public-inbox 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-public-inbox and the dependencies in a project isolated environment using:
$ poetry install
To spaw a new shell within the virtual environment use:
$ poetry shell
Example
Public Inbox
Download the mirror repositories from any public-inbox archive. For example, for the case of the Linux Kernel there are 14 repositories. You can group all the repositories into a single repository using the git alternates mechanism.
Finally, run perceval with the mailing-list URL and the directory with the repository. For example:
$ perceval public_inbox https://lore.kernel.org/lkml/ /tmp/lkml.git
License
Licensed under GNU General Public License (GPL), version 3 or later.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for perceval_public_inbox-0.1.14.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 385ec52e8ba8df9b4f3f96c917f257c443215b32909d8a5abf5ba2860ae96106 |
|
| MD5 | 320e1913fb6ae339cf84a4c5f8eb81fe |
|
| BLAKE2b-256 | f656d9adf1344639394fb00d51f99eed1e78a9afa4abff4dbbcef830e50b373d |
Hashes for perceval_public_inbox-0.1.14-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8dfa4928970b4482134949e84d812f0786a1fd1ba681d9d977e8910d827c8cc6 |
|
| MD5 | cf25a18402ac839c6f9a0f0a723657b5 |
|
| BLAKE2b-256 | 80b4f00fe5a5f03d08370f58e9c50797b3709b0de74e8a4f4bf547f8654c0abe |
