# GrimoireELK public-inbox plugin
public-inbox archive plugin for GrimoireELK.
## 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 grimoire-elk-public-inbox on your system: packages or source
code using Poetry or pip.
### PyPI
grimoire-elk-public-inbox can be installed using pip, a tool for installing Python packages.
To do it, run the next command:
```
$ pip install grimoire-elk-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-elk-public-inbox
$ cd grimoirelab-elk-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 grimoire-elk-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 grimoire-elk-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
```
## License
Licensed under GNU General Public License (GPL), version 3 or later.
Raw data
{
"_id": null,
"home_page": "https://chaoss.github.io/grimoirelab/",
"name": "grimoire-elk-public-inbox",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "development,grimoirelab",
"author": "GrimoireLab Developers",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/23/ad/5f49c87db648e953e2d6ceae103244aab4f3032e4bf77375b53dda76e013/grimoire_elk_public_inbox-0.1.8.tar.gz",
"platform": null,
"description": "# GrimoireELK public-inbox plugin\n\npublic-inbox archive plugin for GrimoireELK. \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 grimoire-elk-public-inbox on your system: packages or source \ncode using Poetry or pip.\n\n### PyPI\n\ngrimoire-elk-public-inbox can be installed using pip, a tool for installing Python packages. \nTo do it, run the next command:\n```\n$ pip install grimoire-elk-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-elk-public-inbox\n$ cd grimoirelab-elk-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 grimoire-elk-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 grimoire-elk-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## License\n\nLicensed under GNU General Public License (GPL), version 3 or later.\n",
"bugtrack_url": null,
"license": "GPL-3.0+",
"summary": "GrimoireELK plugic for public-inbox.",
"version": "0.1.8",
"project_urls": {
"Bug Tracker": "https://github.com/bitergia-analytics/grimoirelab-elk-public-inbox/issues",
"Homepage": "https://chaoss.github.io/grimoirelab/",
"Repository": "https://github.com/bitergia-analytics/grimoirelab-elk-public-inbox"
},
"split_keywords": [
"development",
"grimoirelab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ec77c82de2d032452a63d6c1cd95cb8e48f7b9e2a67fc59393d1374449e728d4",
"md5": "ebfec660b6629f7ff0f4af65a1d6f1f4",
"sha256": "2584790c16ffbe20acc6557ee3fb452f9c77505509c0da62be27ffc3b8e39b26"
},
"downloads": -1,
"filename": "grimoire_elk_public_inbox-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ebfec660b6629f7ff0f4af65a1d6f1f4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 18159,
"upload_time": "2024-01-02T13:08:43",
"upload_time_iso_8601": "2024-01-02T13:08:43.154752Z",
"url": "https://files.pythonhosted.org/packages/ec/77/c82de2d032452a63d6c1cd95cb8e48f7b9e2a67fc59393d1374449e728d4/grimoire_elk_public_inbox-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "23ad5f49c87db648e953e2d6ceae103244aab4f3032e4bf77375b53dda76e013",
"md5": "072341e428033cb27044678bc8d89a26",
"sha256": "3748e820e575d29d4dadb311735eed4eb90f3514eafe8bd5b5438a4c961fe721"
},
"downloads": -1,
"filename": "grimoire_elk_public_inbox-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "072341e428033cb27044678bc8d89a26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 15691,
"upload_time": "2024-01-02T13:08:44",
"upload_time_iso_8601": "2024-01-02T13:08:44.940276Z",
"url": "https://files.pythonhosted.org/packages/23/ad/5f49c87db648e953e2d6ceae103244aab4f3032e4bf77375b53dda76e013/grimoire_elk_public_inbox-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-02 13:08:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bitergia-analytics",
"github_project": "grimoirelab-elk-public-inbox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "grimoire-elk-public-inbox"
}
JSON
