# perceval-topicbox
Perceval backend for Topicbox.
## Backends
The backend currently managed by this package support the next repository:
* Topicbox
## 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-topicbox on your system: packages or source
code using Poetry or pip.
### PyPI
perceval-topicbox can be installed using pip, a tool for installing Python packages.
To do it, run the next command:
```
$ pip install perceval-topicbox
```
### 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-topicbox
$ cd grimoirelab-perceval-topicbox
```
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-topicbox 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-topicbox and the dependencies in
a project isolated environment using:
```
$ poetry install
```
To spaw a new shell within the virtual environment use:
```
$ poetry shell
```
## Example
### Topicbox
You need an `account_id` and a group URL to fetch the messages.
- To obtain the `account_id`, open Network tab in the browser Devtool and identify the `accountId` in any
`/jmap` request made by the browser.
Run perceval with the Topicbox group URL and the account id to fetch the messages. For example:
```
$ perceval topicbox "https://mytopicbox.topicbox.com/groups/example" --account-id <account_id>
```
It can be run from a specific date using the `--from-date` parameter.
## 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-topicbox",
"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/02/7a/f93f119825f54bc7138f99cf1d8f7bd694f628ef9bbf25124d43cea63445/perceval_topicbox-0.1.6.tar.gz",
"platform": null,
"description": "# perceval-topicbox\n\nPerceval backend for Topicbox.\n\n## Backends\n\nThe backend currently managed by this package support the next repository:\n\n* Topicbox\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-topicbox on your system: packages or source \ncode using Poetry or pip.\n\n### PyPI\n\nperceval-topicbox can be installed using pip, a tool for installing Python packages. \nTo do it, run the next command:\n```\n$ pip install perceval-topicbox\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-topicbox\n$ cd grimoirelab-perceval-topicbox\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-topicbox 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-topicbox 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### Topicbox\n\nYou need an `account_id` and a group URL to fetch the messages.\n\n- To obtain the `account_id`, open Network tab in the browser Devtool and identify the `accountId` in any\n`/jmap` request made by the browser.\n\nRun perceval with the Topicbox group URL and the account id to fetch the messages. For example:\n\n```\n$ perceval topicbox \"https://mytopicbox.topicbox.com/groups/example\" --account-id <account_id>\n```\n\nIt can be run from a specific date using the `--from-date` parameter.\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 Topicbox",
"version": "0.1.6",
"project_urls": {
"Bug Tracker": "https://github.com/bitergia-analytics/grimoirelab-perceval-topicbox/issues",
"Homepage": "https://chaoss.github.io/grimoirelab/",
"Repository": "https://github.com/bitergia-analytics/grimoirelab-perceval-topicbox"
},
"split_keywords": [
"development",
" grimoirelab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e133e3ad40ba74512f417c38e347a4e0326caf9a7cfbe34926609d5883880acd",
"md5": "4dfba4ff33ce266bdabcb2c17c2f0df6",
"sha256": "1c676878f1c98fa7901718e13ab682c1cde8dce3767aca14b467cc57c3049569"
},
"downloads": -1,
"filename": "perceval_topicbox-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4dfba4ff33ce266bdabcb2c17c2f0df6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 18256,
"upload_time": "2024-05-09T13:02:30",
"upload_time_iso_8601": "2024-05-09T13:02:30.002419Z",
"url": "https://files.pythonhosted.org/packages/e1/33/e3ad40ba74512f417c38e347a4e0326caf9a7cfbe34926609d5883880acd/perceval_topicbox-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "027af93f119825f54bc7138f99cf1d8f7bd694f628ef9bbf25124d43cea63445",
"md5": "3a592e994e70122015db60f0bbdfff75",
"sha256": "c7623bce7823d301c89912a697d26e2607a16dd0051fe56ebe39cfda248e0d19"
},
"downloads": -1,
"filename": "perceval_topicbox-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "3a592e994e70122015db60f0bbdfff75",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 23222,
"upload_time": "2024-05-09T13:02:31",
"upload_time_iso_8601": "2024-05-09T13:02:31.126754Z",
"url": "https://files.pythonhosted.org/packages/02/7a/f93f119825f54bc7138f99cf1d8f7bd694f628ef9bbf25124d43cea63445/perceval_topicbox-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-09 13:02:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bitergia-analytics",
"github_project": "grimoirelab-perceval-topicbox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "perceval-topicbox"
}
JSON
