# 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](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](https://python-poetry.org/) for dependency management and
packaging. You can install it following its [documentation](https://python-poetry.org/docs/#installation).
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](https://lore.kernel.org/lkml/_/text/mirror/).
You can group all the repositories into a single repository using the [git
alternates mechanism](https://git-scm.com/docs/gitrepository-layout#Documentation/gitrepository-layout.txt-objects).
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.
Raw data
{
"_id": null,
"home_page": "https://chaoss.github.io/grimoirelab/",
"name": "perceval-public-inbox",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "development, grimoirelab",
"author": "GrimoireLab Developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/8f/18/0ff0518439816c3357c60b3083b7daae9c456d80a9957cd0eed2c83fcbf3/perceval_public_inbox-0.1.15.tar.gz",
"platform": null,
"description": "# perceval-public-inbox\n\nPerceval backend for public-inbox repositories.\n\n## Backends\n\nThe backend currently managed by this package support the next repository:\n\n* public-inbox\n\n## Requirements\n\n * Python >= 3.8\n\nYou will also need some other libraries for running the tool, you can find the\nwhole list of dependencies in [pyproject.toml](pyproject.toml) file.\n\n## Installation\n\nThere are several ways to install perceval-public-inbox on your system: packages or source \ncode using Poetry or pip.\n\n### PyPI\n\nperceval-public-inbox can be installed using pip, a tool for installing Python packages. \nTo do it, run the next command:\n```\n$ pip install perceval-public-inbox\n```\n\n### Source code\n\nTo install from the source code you will need to clone the repository first:\n```\n$ git clone https://github.com/bitergia-analytics/grimoirelab-perceval-public-inbox\n$ cd grimoirelab-perceval-public-inbox\n```\n\nThen use pip or Poetry to install the package along with its dependencies.\n\n#### Pip\nTo install the package from local directory run the following command:\n```\n$ pip install .\n```\nIn case you are a developer, you should install perceval-public-inbox in editable mode:\n```\n$ pip install -e .\n```\n\n#### Poetry\nWe use [poetry](https://python-poetry.org/) for dependency management and \npackaging. You can install it following its [documentation](https://python-poetry.org/docs/#installation).\nOnce you have installed it, you can install perceval-public-inbox and the dependencies in \na project isolated environment using:\n```\n$ poetry install\n```\nTo spaw a new shell within the virtual environment use:\n```\n$ poetry shell\n```\n\n## Example\n\n### Public Inbox\n\nDownload the mirror repositories from any public-inbox archive. For example, for\nthe case of the Linux Kernel there are [14 repositories](https://lore.kernel.org/lkml/_/text/mirror/).\nYou can group all the repositories into a single repository using the [git\nalternates mechanism](https://git-scm.com/docs/gitrepository-layout#Documentation/gitrepository-layout.txt-objects).\n\nFinally, run perceval with the mailing-list URL and the directory with the\nrepository. For example:\n```\n$ perceval public_inbox https://lore.kernel.org/lkml/ /tmp/lkml.git\n```\n\n## License\n\nLicensed under GNU General Public License (GPL), version 3 or later.\n",
"bugtrack_url": null,
"license": "GPL-3.0+",
"summary": "Perceval backend for public-inbox.",
"version": "0.1.15",
"project_urls": {
"Bug Tracker": "https://github.com/bitergia-analytics/grimoirelab-perceval-public-inbox/issues",
"Homepage": "https://chaoss.github.io/grimoirelab/",
"Repository": "https://github.com/bitergia-analytics/grimoirelab-perceval-public-inbox"
},
"split_keywords": [
"development",
" grimoirelab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4feac28946e3d55b4e97db2c678acd5db816db89ba15b1b4c464f2adc492886d",
"md5": "6689c14f4054807af47c2f6dc34eead6",
"sha256": "1aec626a06e0d1a9b79fdc95a4983736b953066b4facedcf82014b3be35259d8"
},
"downloads": -1,
"filename": "perceval_public_inbox-0.1.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6689c14f4054807af47c2f6dc34eead6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 19151,
"upload_time": "2024-05-09T13:02:19",
"upload_time_iso_8601": "2024-05-09T13:02:19.579960Z",
"url": "https://files.pythonhosted.org/packages/4f/ea/c28946e3d55b4e97db2c678acd5db816db89ba15b1b4c464f2adc492886d/perceval_public_inbox-0.1.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f180ff0518439816c3357c60b3083b7daae9c456d80a9957cd0eed2c83fcbf3",
"md5": "6641af9f20e59e4d534ff3a34cb0d288",
"sha256": "5697d2bb9ca0ae0ca8182ce1c2778c92804ef19d15e22b5475b137cf191acb0b"
},
"downloads": -1,
"filename": "perceval_public_inbox-0.1.15.tar.gz",
"has_sig": false,
"md5_digest": "6641af9f20e59e4d534ff3a34cb0d288",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 117994,
"upload_time": "2024-05-09T13:02:21",
"upload_time_iso_8601": "2024-05-09T13:02:21.296810Z",
"url": "https://files.pythonhosted.org/packages/8f/18/0ff0518439816c3357c60b3083b7daae9c456d80a9957cd0eed2c83fcbf3/perceval_public_inbox-0.1.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-09 13:02:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bitergia-analytics",
"github_project": "grimoirelab-perceval-public-inbox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "perceval-public-inbox"
}
JSON
