Exporting SupportBee data for better integration with other ticketing tools
Project description
beedumper
A tool to export data from SupportBee ticketing tool
Install
This is not uploaded to pip (yet) so you need to set up your environment like this:
- Clone this repo
- Install
poetry
:pip install --user poetry
poetry install
That should leave your folder ready to start using poetry run beedumper
to execute the main command line interface but you can also import beedumper.export.Exporter
class and work directly with the different methods.
beedumper
CLI command
$ poetry run beedumper -h
Usage: beedumper [OPTIONS] COMMAND [ARGS]...
This command line tool helps you export your SupportBee account data.
Options:
-l, --loglevel [error|warn|info|debug]
-c, --config PATH Defaults to current folder "config.yaml"
-v, --version Show the version and exit.
-h, --help Show this message and exit.
Commands:
all Export all account info, both metadata and tickets
all-metadata Export all metadata
all-tickets Export all ticket info: tickets, replies, comments
and...
emails Exports the forwarding addresses
export-attachments Exports all attachments from the tickets stored
export-comments Exports all comments from the tickets stored
export-replies Exports all replies from the tickets stored
export-tickets Exports all tickets in a folder structure
labels Exports the labels
snippets Exports the snippets
teams Exports the teams
users Exports the users
Check the example configuration to set up your config.yaml
file with SupportBee credentials and other settings.
Some subcommands may have further options, use -h
to find out more about them.
Tickets storage
The tickets are stored under a folder tickets
below your defined output directory. For each ticket a folder is created with its id
under an intermediate folder that is the modulus of the id by 99
. That is, under tickets you'll eventually have folders running from 00
to 98
spreading the tickets approximately evenly over them.
Under each ticket folder you'll eventually end with this structure:
ticket.json
: main informationreplies.json
: array of replies made to the requestercomments.json
: comments made by agentsattachments
: folder with attachment files by the original requesterattachments_replies
: folder with attachments coming from the replies
Recommended usage
It's recommended to first run the simple subcommands like users
or labels
to test things work as expected. Then you can start with export-tickets --since-date
passing a recent date to download only a few tickets. Then you can do the same with export-replies
, export-comments
, and export-attachments
sequentially, as replies and comments are based on existing tickets, and attachments use both tickets and replies JSON files.
If there are no issues on downloading those recent assets, you can then run all
to download the full dump of tickets information and in subsequent executions use the --since-date
parameter to only download tickets with last_activity_at
metadata older than the passed timestamp to keep your dump updated with recent changes.
Project details
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 beedumper-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c11b182c3ce78ac9af41aa67aae7a3683a302d21e34f93079c49a78c2b0f5f07 |
|
MD5 | 28956be52083d2798a8db8b24a27359a |
|
BLAKE2b-256 | 1a1b173032c6d0cf1c8df3b631a7a25faffaf4a86a4bb54e26cf8b8c4917018f |