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.10

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.

Metadata

Release files for perceval-public-inbox 0.2.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for perceval-public-inbox 0.2.10
File	Size	Uploaded
perceval_public_inbox-0.2.10.tar.gz	117.9 kB	Jun 22, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for perceval-public-inbox 0.2.10
File	Interpreter	ABI	Platform	Reset
perceval_public_inbox-0.2.10-py3-none-any.whl 19.5 kB Jun 22, 2026	Python 3	none	any	Details

Total release size: 137.4 kB

Release files / perceval_public_inbox-0.2.10.tar.gz

Download URL	perceval_public_inbox-0.2.10.tar.gz
Size	117.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`05455315c0e41fee5798572e72e6b22f2704d4e7653e37f32724e1026936b6c6`
BLAKE2b-256 checksum How to use checksums	`add223305d55b91b5a513b00c9eddade08c944a45a842c4165787688076b5237`
Upload date	Jun 22, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1018-azure`

Release files / perceval_public_inbox-0.2.10-py3-none-any.whl

Download URL	perceval_public_inbox-0.2.10-py3-none-any.whl
Size	19.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`b2548d9eca29cd4b0f79c1419621759aabae3d642e071fbed5a63b132590aed2`
BLAKE2b-256 checksum How to use checksums	`3f351bdcf698172e069a197c8b95b4aa5ded4b17e492ffee937995cfc4d19509`
Upload date	Jun 22, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1018-azure`