{ "info": { "author": "Felipe de Mello", "author_email": "fdemello@cisco.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Information Technology", "Intended Audience :: System Administrators", "Intended Audience :: Telecommunications Industry", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Communications", "Topic :: Communications :: Chat" ], "description": "=====================\nWebex Teams Archiver\n=====================\n\n*Simple utility to archive Webex Teams rooms*\n\n.. image:: https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg\n :target: https://developer.cisco.com/codeexchange/github/repo/CiscoDevNet/webex-teams-archiver\n.. image:: https://img.shields.io/badge/license-MIT-blue.svg\n :target: https://github.com/CiscoDevNet/webex-teams-archiver/blob/master/LICENSE\n.. image:: https://img.shields.io/pypi/v/webexteamsarchiver.svg\n :target: https://pypi.python.org/pypi/webexteamsarchiver\n\n-------------------------------------------------------------------------------\n\nWebex Teams Archiver extracts the messages and files out of a Webex Teams room and saves them in text, HTML, and JSON formats.\n\nExample\n-------\n\n.. code-block:: python\n\n from webexteamsarchiver import WebexTeamsArchiver\n\n personal_token = \"mytoken\"\n archiver = WebexTeamsArchiver(personal_token)\n \n # room id from https://developer.webex.com/endpoint-rooms-get.html \n room_id = \"Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy\"\n archiver.archive_room(room_id)\n \nProduces the following files:\n\n.. code-block:: bash\n\n $ ls \n Title_Timestamp_Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy.tgz\n Title_Timestamp_Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy\n\n $ ls Title_Timestamp_Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy/\n Title_Timestamp_Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy.html\n Title_Timestamp_Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy.json\n Title_Timestamp_Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy.txt\n attachments/\n avatars/\n space_details.json\n\nBelow is an example of a simple room that got archived.\n\n.. image:: https://raw.githubusercontent.com/CiscoDevNet/webex-teams-archiver/master/sample.png\n :scale: 40 %\n\n\nNote 1: The HTML version of the archive requires Internet connectivity because of the CSS, which is not packaged with the archive because of licensing conflicts.\n\nNote 2: Please note that use of the Webex Teams Archiver may violate the retention policy, if any, applicable to your use of Webex Teams.\n\nInstallation\n------------\n\nInstalling and upgrading is easy:\n\n**Install via PIP**\n\n.. code-block:: bash\n\n $ pip install webexteamsarchiver\n\n**Upgrading to the latest Version**\n\n.. code-block:: bash\n\n $ pip install webexteamsarchiver --upgrade\n\nOptions\n-------\n\nThe `archive_room` method exposes the following options:\n\n+----------------------+-------------------+---------------------------------------------------+ \n| Argument | Default Value | Description | \n+======================+===================+===================================================+\n| text_format | True | Create a text version of the archive |\n+----------------------+-------------------+---------------------------------------------------+\n| html_format | True | Create an HTML version of the archive |\n+----------------------+-------------------+---------------------------------------------------+\n| json_format | True | Create a JSON version of the archive |\n+----------------------+-------------------+---------------------------------------------------+\n\n\nIn addition, the `options` kwargs supports the following additional options today:\n\n+----------------------+-------------------+---------------------------------------------------+ \n| Argument | Default Value | Description | \n+======================+===================+===================================================+\n| overwrite_folder | True | Overwrite the archive folder if it already exists |\n+----------------------+-------------------+---------------------------------------------------+\n| delete_folder | False | Delete the archive folder when done |\n+----------------------+-------------------+---------------------------------------------------+\n| reverse_order | True | Order messages by most recent on the bottom |\n+----------------------+-------------------+---------------------------------------------------+\n| download_attachments | True | Download attachments sent to the room |\n+----------------------+-------------------+---------------------------------------------------+\n| download_avatars | True | Download avatar images |\n+----------------------+-------------------+---------------------------------------------------+\n| download_workers | 15 | Number of download workers for downloading files |\n+----------------------+-------------------+---------------------------------------------------+\n| timestamp_format | %Y-%m-%dT%H:%M:%S | Timestamp strftime format |\n+----------------------+-------------------+---------------------------------------------------+\n| file_format | gztar | Archive file format_ |\n+----------------------+-------------------+---------------------------------------------------+\n\nQuestions, Support & Discussion\n-------------------------------\n\nwebexteamsarchiver_ is a *community developed* and *community supported* project. Feedback, thoughts, questions, issues can be submitted using the issues_ page.\n\nContribution\n------------\n\nwebexteamsarchiver_ is a *community developed* project. Code contributions are welcome via PRs!\n\n*Copyright (c) 2018-2019 Cisco and/or its affiliates.*\n\n\n.. _webexteamsarchiver: https://github.com/CiscoDevNet/webex-teams-archiver\n.. _issues: https://github.com/CiscoDevNet/webex-teams-archiver/issues\n.. _format: https://docs.python.org/3/library/shutil.html#shutil.make_archive", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/CiscoDevNet/webex-teams-archiver", "keywords": "cisco webex teams spark python messaging", "license": "MIT; Copyright (c) 2018 Cisco Systems, Inc.", "maintainer": "", "maintainer_email": "", "name": "webexteamsarchiver", "package_url": "https://pypi.org/project/webexteamsarchiver/", "platform": "", "project_url": "https://pypi.org/project/webexteamsarchiver/", "project_urls": { "Homepage": "https://github.com/CiscoDevNet/webex-teams-archiver" }, "release_url": "https://pypi.org/project/webexteamsarchiver/0.9.1/", "requires_dist": null, "requires_python": "", "summary": "Room archiver utility for Webex Teams", "version": "0.9.1" }, "last_serial": 5773682, "releases": { "0.8.4": [ { "comment_text": "", "digests": { "md5": "6875fe0b88de5cbc71ae4521fb806cb2", "sha256": "df7bb1e587008332e105df7c90ca1401577f8dfcdb37de3cb873a1809422292c" }, "downloads": -1, "filename": "webexteamsarchiver-0.8.4.tar.gz", "has_sig": false, "md5_digest": "6875fe0b88de5cbc71ae4521fb806cb2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 387385, "upload_time": "2019-02-07T23:40:06", "url": "https://files.pythonhosted.org/packages/4e/59/d7e577cdf08a79305ffd7a746fa27ef0625934e493b52460002017323be0/webexteamsarchiver-0.8.4.tar.gz" } ], "0.8.5": [ { "comment_text": "", "digests": { "md5": "f5d4d2d159c81a20ee0874dc5c7df0c0", "sha256": "6f462f1bda312b4d1b369fc44ac76ecec2a953486c84157221057a1f98919bb9" }, "downloads": -1, "filename": "webexteamsarchiver-0.8.5.tar.gz", "has_sig": false, "md5_digest": "f5d4d2d159c81a20ee0874dc5c7df0c0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 387447, "upload_time": "2019-02-08T17:44:54", "url": "https://files.pythonhosted.org/packages/df/61/b661616475be35fff8343fe84d574f44951ac1a6453be0808b7bccb1c780/webexteamsarchiver-0.8.5.tar.gz" } ], "0.8.6": [ { "comment_text": "", "digests": { "md5": "7ce5357fc327b80f5bcc34489558ad37", "sha256": "152e72bdb40e8f9d7517ee6e7c2b845de3e9709509e0dd90f6f392093a466b9c" }, "downloads": -1, "filename": "webexteamsarchiver-0.8.6.tar.gz", "has_sig": false, "md5_digest": "7ce5357fc327b80f5bcc34489558ad37", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 387462, "upload_time": "2019-02-08T20:09:50", "url": "https://files.pythonhosted.org/packages/b2/fa/5103bc89d81f6c324825d876d5bc0efca1da9a7b442d0c104a603a654cc0/webexteamsarchiver-0.8.6.tar.gz" } ], "0.8.7": [ { "comment_text": "", "digests": { "md5": "67dc92dc4803bb7949dcbdd337980dea", "sha256": "e7b218572908d334f939ddbee3277830a60db9dcb1b548807e96efb3901dfa03" }, "downloads": -1, "filename": "webexteamsarchiver-0.8.7.tar.gz", "has_sig": false, "md5_digest": "67dc92dc4803bb7949dcbdd337980dea", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 387483, "upload_time": "2019-02-14T18:06:58", "url": "https://files.pythonhosted.org/packages/b4/33/417dbb1ab60eee122a261dae34e1313f959ae0d8d3e502df8d87b3a89f9b/webexteamsarchiver-0.8.7.tar.gz" } ], "0.9.1": [ { "comment_text": "", "digests": { "md5": "152f1abad9ab61b4d3aa4dbd77cef5e3", "sha256": "8340680d11ab05aa3b5989b5813f03cb24e506b2fa167b5357690c9368ce183c" }, "downloads": -1, "filename": "webexteamsarchiver-0.9.1.tar.gz", "has_sig": false, "md5_digest": "152f1abad9ab61b4d3aa4dbd77cef5e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1540057, "upload_time": "2019-09-03T03:42:15", "url": "https://files.pythonhosted.org/packages/93/4a/816f5b668797677af44293c553f7311ebb5523628a8b61abedbc7cac20cf/webexteamsarchiver-0.9.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "152f1abad9ab61b4d3aa4dbd77cef5e3", "sha256": "8340680d11ab05aa3b5989b5813f03cb24e506b2fa167b5357690c9368ce183c" }, "downloads": -1, "filename": "webexteamsarchiver-0.9.1.tar.gz", "has_sig": false, "md5_digest": "152f1abad9ab61b4d3aa4dbd77cef5e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1540057, "upload_time": "2019-09-03T03:42:15", "url": "https://files.pythonhosted.org/packages/93/4a/816f5b668797677af44293c553f7311ebb5523628a8b61abedbc7cac20cf/webexteamsarchiver-0.9.1.tar.gz" } ] }