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.
Project details
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.13rc1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72ebe7418edd91b41dc93fa30c86b4e68a05b071151c36498d7302357e601f37 |
|
MD5 | 57183e1794b47b67ed14c71c09a052f3 |
|
BLAKE2b-256 | 0875bb52fe27e576bd4875cb794fbd62f726a67bc307d1447101c1a2289be02c |
Hashes for perceval_public_inbox-0.1.13rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dbdc8f3f889067af1d5d9375bbf64d499544e3214f5ab28cc8ea908353f52ba5 |
|
MD5 | 89370628658f82ef4171008513b52775 |
|
BLAKE2b-256 | 9534e3b35f1f7f5a985e296e4d87980223444d5a493c89a3c1d0f164a37d9611 |