{"id":20588674,"url":"https://github.com/ciscodevnet/webex-teams-archiver","last_synced_at":"2025-04-14T21:54:03.156Z","repository":{"id":34012274,"uuid":"150178754","full_name":"CiscoDevNet/webex-teams-archiver","owner":"CiscoDevNet","description":" Simple utility to archive Webex Teams rooms","archived":false,"fork":false,"pushed_at":"2022-12-27T16:36:14.000Z","size":2600,"stargazers_count":22,"open_issues_count":4,"forks_count":11,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-04-14T21:53:44.453Z","etag":null,"topics":["cisco","cisco-spark","python3","webex","webex-teams","webex-teams-sdk"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CiscoDevNet.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-24T22:57:45.000Z","updated_at":"2024-03-09T13:19:50.000Z","dependencies_parsed_at":"2023-01-15T03:57:15.180Z","dependency_job_id":null,"html_url":"https://github.com/CiscoDevNet/webex-teams-archiver","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fwebex-teams-archiver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fwebex-teams-archiver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fwebex-teams-archiver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fwebex-teams-archiver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CiscoDevNet","download_url":"https://codeload.github.com/CiscoDevNet/webex-teams-archiver/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248968755,"owners_count":21191158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cisco","cisco-spark","python3","webex","webex-teams","webex-teams-sdk"],"created_at":"2024-11-16T07:25:49.092Z","updated_at":"2025-04-14T21:54:03.137Z","avatar_url":"https://github.com/CiscoDevNet.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=====================\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/docs/api/v1/rooms/list-rooms\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.tgz\n    Title_Timestamp\n\n    $ ls Title_Timestamp/\n    Title_Timestamp.html\n    Title_Timestamp.json\n    Title_Timestamp.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| compress_folder      | True              | Compress archive folder                           |\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 \u0026 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-2021 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\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fciscodevnet%2Fwebex-teams-archiver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fciscodevnet%2Fwebex-teams-archiver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fciscodevnet%2Fwebex-teams-archiver/lists"}