# Bitergia Analytics GrimoireELK backends
GrimoireELK backends available in Bitergia Analytics:
### public-inbox
Software for efficiently managing and archiving public mailing
lists using Git repositories.
- `projects.json`
```
{
"linux": {
"public_inbox": [
"linux /path/to/mirror/repository"
]
}
}
```
- `setup.cfg`
```
[public_inbox]
raw_index = public_inbox_raw
enriched_index = public_inbox_enriched
latest-items = false
```
### Topicbox
Email discussion platform that facilitates organized group
communication through dedicated email groups.
- `projects.json`
```
{
"Example": {
"topicbox": [
"https://example.topicbox.com/groups/group-1",
"https://example.topicbox.com/groups/group-2"
]
}
}
```
- `setup.cfg`
```
[topicbox]
raw_index = topicbox_raw
enriched_index = topicbox_enriched
account-id = xxxx # Look into the Perceval backend
studies = [ enrich_demography:topicbox ] # (optional)
[enrich_demography:topicbox] # (optional)
```
### Pontoon
Web-based localization platform that facilitates collaborative
translation of software and documentation
- `projects.json`
```
{
"Example": {
"pontoon": [
"https://pontoon.mozilla.org af",
"https://pontoon.mozilla.org es"
]
}
}
```
- `setup.cfg`
```
[pontoon]
raw_index = pontoon_raw
enriched_index = pontoon_enriched
studies = [ enrich_demography:pontoon ] # (optional)
[enrich_demography:pontoon] # (optional)
```
## 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": "bap-elk-backends",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "development, grimoirelab",
"author": "Bitergia Developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/0c/84/1497495ae1a22bfcaa19b57e85e50782246de13a8850e6b5f17aae1a2f5d/bap_elk_backends-0.5.2.tar.gz",
"platform": null,
"description": "# Bitergia Analytics GrimoireELK backends\n\nGrimoireELK backends available in Bitergia Analytics:\n### public-inbox\n\nSoftware for efficiently managing and archiving public mailing\nlists using Git repositories.\n- `projects.json`\n```\n{\n \"linux\": {\n \"public_inbox\": [\n \"linux /path/to/mirror/repository\"\n ]\n }\n}\n```\n\n- `setup.cfg`\n```\n[public_inbox]\nraw_index = public_inbox_raw\nenriched_index = public_inbox_enriched\nlatest-items = false\n```\n\n### Topicbox\n\nEmail discussion platform that facilitates organized group\ncommunication through dedicated email groups.\n\n- `projects.json`\n```\n{\n \"Example\": {\n \"topicbox\": [\n \"https://example.topicbox.com/groups/group-1\",\n \"https://example.topicbox.com/groups/group-2\"\n ]\n }\n}\n```\n\n- `setup.cfg`\n```\n[topicbox]\nraw_index = topicbox_raw\nenriched_index = topicbox_enriched\naccount-id = xxxx # Look into the Perceval backend\nstudies = [ enrich_demography:topicbox ] # (optional)\n\n[enrich_demography:topicbox] # (optional)\n```\n\n### Pontoon\n\nWeb-based localization platform that facilitates collaborative\ntranslation of software and documentation\n\n- `projects.json`\n```\n{\n \"Example\": {\n \"pontoon\": [\n \"https://pontoon.mozilla.org af\",\n \"https://pontoon.mozilla.org es\"\n ]\n }\n}\n```\n\n- `setup.cfg`\n```\n[pontoon]\nraw_index = pontoon_raw\nenriched_index = pontoon_enriched\nstudies = [ enrich_demography:pontoon ] # (optional)\n\n[enrich_demography:pontoon] # (optional)\n```\n\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.5.2",
"project_urls": {
"Bug Tracker": "https://github.com/bitergia-analytics/bitergia-analytics-elk-backends/issues",
"Homepage": "https://chaoss.github.io/grimoirelab/",
"Repository": "https://github.com/bitergia-analytics/bitergia-analytics-elk-backends"
},
"split_keywords": [
"development",
" grimoirelab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cc4c043c9cf97dbec312d9848167a19d24aef41f8a27d9e7bb7bac3338ec3262",
"md5": "2a44bf4150b83b348f8c577be591a5ea",
"sha256": "9fcf577e73966e6555f10ba36a8256c2fd325191d4b7add033c4f9049c8dc921"
},
"downloads": -1,
"filename": "bap_elk_backends-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2a44bf4150b83b348f8c577be591a5ea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 25058,
"upload_time": "2024-04-16T09:11:15",
"upload_time_iso_8601": "2024-04-16T09:11:15.147207Z",
"url": "https://files.pythonhosted.org/packages/cc/4c/043c9cf97dbec312d9848167a19d24aef41f8a27d9e7bb7bac3338ec3262/bap_elk_backends-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0c841497495ae1a22bfcaa19b57e85e50782246de13a8850e6b5f17aae1a2f5d",
"md5": "5378c72bb852631c22e62715a0244e25",
"sha256": "ebedfb02cf89a355c4f39d5e6dbf12e607d392035dfb51d246088588e8ca1238"
},
"downloads": -1,
"filename": "bap_elk_backends-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "5378c72bb852631c22e62715a0244e25",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 20263,
"upload_time": "2024-04-16T09:11:16",
"upload_time_iso_8601": "2024-04-16T09:11:16.883346Z",
"url": "https://files.pythonhosted.org/packages/0c/84/1497495ae1a22bfcaa19b57e85e50782246de13a8850e6b5f17aae1a2f5d/bap_elk_backends-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 09:11:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bitergia-analytics",
"github_project": "bitergia-analytics-elk-backends",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bap-elk-backends"
}
JSON
