perceval-topicbox
Perceval backend for Topicbox.
Backends
The backend currently managed by this package support the next repository:
- Topicbox
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-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 for dependency management and packaging. You can install it following its documentation. 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 theaccountIdin any/jmaprequest 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.
1 maintainer
Metadata
1 maintainer
Release files for perceval-topicbox 0.2.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| perceval_topicbox-0.2.10.tar.gz | 23.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| perceval_topicbox-0.2.10-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 41.8 kB
Release files / perceval_topicbox-0.2.10.tar.gz
| Download URL | perceval_topicbox-0.2.10.tar.gz |
|---|---|
| Size | 23.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b5be084fd62fe929f0da5fe0aa89da7c717d88b5c039b4f5b1589f9db3f9f610
|
|
BLAKE2b-256 checksum How to use checksums |
aa0bf569643ab4323601b8263309abeaac2e53993d49f0a1968a6d8bf984af56
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1018-azure
|
Release files / perceval_topicbox-0.2.10-py3-none-any.whl
| Download URL | perceval_topicbox-0.2.10-py3-none-any.whl |
|---|---|
| Size | 18.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c2c501da09eda15418ce0d6c2b7cc3f634958529dcf66783ff9c92bbf2b758f1
|
|
BLAKE2b-256 checksum How to use checksums |
a1cdaa5e431d4dad72d52eb37e2be2ebf46dc21e558fda7f355ce7efb1f0bc4e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1018-azure
|
