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.9rc1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e9f6bd793af8d150bedd8af9021099cffefde09ff842a7d1f4ca577c5a50713 |
|
MD5 | f1a927bbc10990d3265f2dfadb12a627 |
|
BLAKE2b-256 | 59ac5cd6e9ad37bfbcd35a680c569524926123932a79d76c0e4013a590271efd |
Hashes for perceval_public_inbox-0.1.9rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 343eaf68079fb8433ce3645b704c0f9f0b95e409af9dd79ea873812381bcfa3b |
|
MD5 | 16e2a7f3e50bd9421fd7ba186cd4ff2e |
|
BLAKE2b-256 | 86e0b0d1afd71eb48d3ba3eb585e96254d219934ccada8e84e2b8e67ae24e71b |