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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 249be4ab0cf011c5eb51e8cabbb9235177fe3150a949679755e9a62c202ce960 |
|
MD5 | db063feb9f850f5ba28d5247a65b1ebc |
|
BLAKE2b-256 | 9875f163a9c87385ff07cb5107e69b6dd3910e762982b302e95e549a0ca70179 |
Hashes for perceval_public_inbox-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ab6bf7dcc098a25be66a0d0c96508c6377a73fc50b90fec0366477ea9f1aebb |
|
MD5 | bfc3b83788a997b8c740e75f8fe0ee81 |
|
BLAKE2b-256 | 4a7fd769c7d96950083cc033350e1219614ef291cf982b3813622e136b228771 |