Perceval backend for Topicbox
Project description
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 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 theaccountId
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for perceval_topicbox-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | caa27b105bbd5175094b982afc98646e78b48f0d5c5e19ea57541292a05466d5 |
|
MD5 | 4c8fbe73f2d61cf7f633c7060984b177 |
|
BLAKE2b-256 | dbdc07d011e0c794dc17bff885ad7ca5ee40345fe52c1b8a95091e5dc72dc9e7 |