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.
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file perceval_public_inbox-0.2.10.tar.gz.
File metadata
- Download URL: perceval_public_inbox-0.2.10.tar.gz
- Upload date:
- Size: 117.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
05455315c0e41fee5798572e72e6b22f2704d4e7653e37f32724e1026936b6c6
|
|
| MD5 |
668894223438461f31710ff0756e29ad
|
|
| BLAKE2b-256 |
add223305d55b91b5a513b00c9eddade08c944a45a842c4165787688076b5237
|
File details
Details for the file perceval_public_inbox-0.2.10-py3-none-any.whl.
File metadata
- Download URL: perceval_public_inbox-0.2.10-py3-none-any.whl
- Upload date:
- Size: 19.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b2548d9eca29cd4b0f79c1419621759aabae3d642e071fbed5a63b132590aed2
|
|
| MD5 |
87dcf93e5b3d2b4c010d9d21359db5f3
|
|
| BLAKE2b-256 |
3f351bdcf698172e069a197c8b95b4aa5ded4b17e492ffee937995cfc4d19509
|
