{ "info": { "author": "Jorge Sanz", "author_email": "jsanz@carto.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Customer Service", "Intended Audience :: Information Technology", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Office/Business", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: System :: Archiving :: Backup", "Topic :: System :: Systems Administration" ], "description": "# beedumper: backup your SupportBee data\n\nA tool to backup all your data from [SupportBee](https://supportbee.com) ticketing tool\n\n## Install\n\nThe package is published at PyPi as [beedumper](https://pypi.org/project/beedumper) so you can run `pip install beedumper` on your Python 3.6 environment to install the main command line interface. Alternatively you can also import `beedumper.export.Exporter` class and work directly with the different methods outside the implemented [`cli`](https://github.com/CartoDB/beedumper/blob/master/beedumper/cli.py) logic.\n\n**Note**: This tool requires python 3.6 or later to run.\n\n## `beedumper` CLI command\n\n```txt\n$ beedumper -h\nUsage: beedumper [OPTIONS] COMMAND [ARGS]...\n\n This command line tool helps you export your SupportBee account data.\n\nOptions:\n -l, --loglevel [error|warn|info|debug]\n -c, --config PATH Defaults to current folder \"config.yaml\"\n -v, --version Show the version and exit.\n -h, --help Show this message and exit.\n\nCommands:\n all Export all account info, both metadata and tickets\n all-metadata Export all metadata\n all-tickets Export all ticket info: tickets, replies, comments\n and...\n emails Exports the forwarding addresses\n export-attachments Exports all attachments from the tickets stored\n export-comments Exports all comments from the tickets stored\n export-replies Exports all replies from the tickets stored\n export-tickets Exports all tickets in a folder structure\n labels Exports the labels\n snippets Exports the snippets\n teams Exports the teams\n users Exports the users\n```\n\nCheck the [example configuration](https://github.com/CartoDB/beedumper/blob/master/config.template.yaml) to set up your `config.yaml` file with SupportBee credentials and other settings.\n\nSome subcommands may have further options, use `-h` to find out more about them.\n\n## Tickets storage\n\nThe 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.\n\nUnder each ticket folder you'll eventually end with this structure:\n\n* `ticket.json`: main information\n* `replies.json`: array of replies made to the requester\n* `comments.json`: comments made by agents\n* `attachments`: folder with attachment files by the original requester\n* `attachments_replies`: folder with attachments coming from the replies\n\n## Recommended usage\n\nIt'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.\n\nIf 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.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/CartoDB/beedumper", "keywords": "supportbee,backup", "license": "MIT", "maintainer": "Jorge Sanz", "maintainer_email": "jsanz@carto.com", "name": "beedumper", "package_url": "https://pypi.org/project/beedumper/", "platform": "", "project_url": "https://pypi.org/project/beedumper/", "project_urls": { "Homepage": "https://github.com/CartoDB/beedumper", "Repository": "https://github.com/CartoDB/beedumper" }, "release_url": "https://pypi.org/project/beedumper/0.1.6/", "requires_dist": [ "requests (>=2.21,<3.0)", "PyYAML (>=5.1,<6.0)", "click (>=7.0,<8.0)", "pathos (>=0.2.3,<0.3.0)", "dateparser (>=0.7.1,<0.8.0)" ], "requires_python": ">=3.6,<4.0", "summary": "Exporting SupportBee data for better integration with other ticketing tools", "version": "0.1.6" }, "last_serial": 5517632, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "cebfc060e9196d30f471d1706a3593be", "sha256": "af960adeca4e446f5fcfb5d6b81a0f9ba784a017be1d157fcc30428226112dc6" }, "downloads": -1, "filename": "beedumper-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "cebfc060e9196d30f471d1706a3593be", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 23656, "upload_time": "2019-04-12T09:49:47", "url": "https://files.pythonhosted.org/packages/4a/52/7d25b2a3a6223202bdb73cbfddeb4fff057c11d576fd2b33918b59a802f2/beedumper-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b21185eabe4986fbcc2a62b00bea095f", "sha256": "f235b0a9492fd3efb9474aeabb27dadf385ddd13a54a9def01f18f5b0373879b" }, "downloads": -1, "filename": "beedumper-0.1.1.tar.gz", "has_sig": false, "md5_digest": "b21185eabe4986fbcc2a62b00bea095f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 6293, "upload_time": "2019-04-12T09:49:49", "url": "https://files.pythonhosted.org/packages/a3/c3/c7b03ba53352b43958a47f80b4ebaf21b3ab257f2fc9c74b124330a8422b/beedumper-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "28956be52083d2798a8db8b24a27359a", "sha256": "c11b182c3ce78ac9af41aa67aae7a3683a302d21e34f93079c49a78c2b0f5f07" }, "downloads": -1, "filename": "beedumper-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "28956be52083d2798a8db8b24a27359a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 25623, "upload_time": "2019-04-12T11:19:14", "url": "https://files.pythonhosted.org/packages/1a/1b/173032c6d0cf1c8df3b631a7a25faffaf4a86a4bb54e26cf8b8c4917018f/beedumper-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "312c10727c31bc129f02e39a1a8f2350", "sha256": "7ba471f2c5f4a5895b1d19fca0a79baf7c194d4b723cee39096429e66ebbae14" }, "downloads": -1, "filename": "beedumper-0.1.2.tar.gz", "has_sig": false, "md5_digest": "312c10727c31bc129f02e39a1a8f2350", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 9265, "upload_time": "2019-04-12T11:19:15", "url": "https://files.pythonhosted.org/packages/e0/4a/fb333395481cfaa93c82f47bfa961893873d022fdc8646e11b70ef644b00/beedumper-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "453c37a7f87199c34655660900cc7d6d", "sha256": "1d6b09314278c6f12af604fed630e19ceeaf1a4adadd7ac76844d9c4581f671d" }, "downloads": -1, "filename": "beedumper-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "453c37a7f87199c34655660900cc7d6d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 25674, "upload_time": "2019-04-12T11:33:44", "url": "https://files.pythonhosted.org/packages/60/6b/f03d9348ff83c09b698003b93efb1fe8397435050350086357842f4bf34c/beedumper-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dd02872f5eb5cc7a1f43c2ceee01f948", "sha256": "f3782aaed382162931a870532ceeee28c4a98cf4c5f7b1965e24e88ee65b2c99" }, "downloads": -1, "filename": "beedumper-0.1.3.tar.gz", "has_sig": false, "md5_digest": "dd02872f5eb5cc7a1f43c2ceee01f948", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 9373, "upload_time": "2019-04-12T11:33:45", "url": "https://files.pythonhosted.org/packages/de/ca/e678922f073d2ced93e0be3e215cab2c27e5ba1990fe1d408a0d045c7bae/beedumper-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "f590bff0bebf8e09b88e99be16d8ee62", "sha256": "979d4c393b575d61424691d3bf6b5273bbfecd530c14a0bf74a280e3daa814d3" }, "downloads": -1, "filename": "beedumper-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "f590bff0bebf8e09b88e99be16d8ee62", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 25676, "upload_time": "2019-06-28T09:10:34", "url": "https://files.pythonhosted.org/packages/d6/62/0c819f5b308f588c00dd49acda13a26ef7cf8ba5ed447a75a9f45e7efc3e/beedumper-0.1.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6b16646402756ac0479fecfe3394672c", "sha256": "5bfaeceeea1cd640eb513914080f518b6fab289e782a0e65fddb54b08ffe373c" }, "downloads": -1, "filename": "beedumper-0.1.4.tar.gz", "has_sig": false, "md5_digest": "6b16646402756ac0479fecfe3394672c", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 9383, "upload_time": "2019-06-28T09:10:36", "url": "https://files.pythonhosted.org/packages/87/d7/74acc9e28d387129b7c5d35f588b1aa0a9998f8d24c771f541bf217471f5/beedumper-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "8ba45490e09413164e2591d5e1f6ce05", "sha256": "ba47320f068bf0044a89698b2bd4d706f160394c189a2a54ebc88fe878933fdf" }, "downloads": -1, "filename": "beedumper-0.1.5-py3-none-any.whl", "has_sig": false, "md5_digest": "8ba45490e09413164e2591d5e1f6ce05", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 28983, "upload_time": "2019-07-02T08:43:04", "url": "https://files.pythonhosted.org/packages/bf/b0/1c72fe3802845b80577027f88960ad7c0530eaeacf95f51c2f7ac335d101/beedumper-0.1.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e2e128c298e5bacc7d60cd7fffee5a39", "sha256": "4eda0f02f0d178658c9817404c5576a92f3761c431bbf0885eacf0600e921f7d" }, "downloads": -1, "filename": "beedumper-0.1.5.tar.gz", "has_sig": false, "md5_digest": "e2e128c298e5bacc7d60cd7fffee5a39", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 10007, "upload_time": "2019-07-02T08:43:06", "url": "https://files.pythonhosted.org/packages/39/3d/521c67d7a4638f31a9588e80624beccae22277b962c1ec5a93cdb09b92d4/beedumper-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "d8be3d4da849057a4f91c3a52a7ff5c1", "sha256": "2425b95fc90abc51a77e138c6c3f2b3db0ef4b1e6cd04ada03b8073c573ba7f5" }, "downloads": -1, "filename": "beedumper-0.1.6-py3-none-any.whl", "has_sig": false, "md5_digest": "d8be3d4da849057a4f91c3a52a7ff5c1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 28995, "upload_time": "2019-07-11T13:13:24", "url": "https://files.pythonhosted.org/packages/12/8c/f80bb4b6bd460087ee8a8d1a77ca1345072d2f97e523de1049655991b2e4/beedumper-0.1.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ec51dd1560f0a1f523b1066714bf224c", "sha256": "429399659ac5c8f846520fcf27671ef9ebaece775038b2087bef1b8c94f6a9a3" }, "downloads": -1, "filename": "beedumper-0.1.6.tar.gz", "has_sig": false, "md5_digest": "ec51dd1560f0a1f523b1066714bf224c", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 10021, "upload_time": "2019-07-11T13:13:26", "url": "https://files.pythonhosted.org/packages/d3/57/a967257cb22fc71124b3b6901ac45a83156afe42a4ff381bc4eb80d19c95/beedumper-0.1.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d8be3d4da849057a4f91c3a52a7ff5c1", "sha256": "2425b95fc90abc51a77e138c6c3f2b3db0ef4b1e6cd04ada03b8073c573ba7f5" }, "downloads": -1, "filename": "beedumper-0.1.6-py3-none-any.whl", "has_sig": false, "md5_digest": "d8be3d4da849057a4f91c3a52a7ff5c1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 28995, "upload_time": "2019-07-11T13:13:24", "url": "https://files.pythonhosted.org/packages/12/8c/f80bb4b6bd460087ee8a8d1a77ca1345072d2f97e523de1049655991b2e4/beedumper-0.1.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ec51dd1560f0a1f523b1066714bf224c", "sha256": "429399659ac5c8f846520fcf27671ef9ebaece775038b2087bef1b8c94f6a9a3" }, "downloads": -1, "filename": "beedumper-0.1.6.tar.gz", "has_sig": false, "md5_digest": "ec51dd1560f0a1f523b1066714bf224c", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 10021, "upload_time": "2019-07-11T13:13:26", "url": "https://files.pythonhosted.org/packages/d3/57/a967257cb22fc71124b3b6901ac45a83156afe42a4ff381bc4eb80d19c95/beedumper-0.1.6.tar.gz" } ] }