Skip to main content

Room archiver utility for Webex Teams

Project description

Simple utility to archive Webex Teams rooms

https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg https://img.shields.io/badge/license-MIT-blue.svg https://img.shields.io/pypi/v/webexteamsarchiver.svg

Webex Teams Archiver extracts the messages and files out of a Webex Teams room and saves them in text, HTML, and JSON formats.

Example

from webexteamsarchiver import WebexTeamsArchiver

personal_token = "mytoken"
archiver = WebexTeamsArchiver(personal_token)

# room id from https://developer.webex.com/endpoint-rooms-get.html
room_id = "Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy"
archiver.archive_room(room_id)

Produces the following files:

$ ls
Title_Timestamp_Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy.tgz
Title_Timestamp_Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy

$ ls Title_Timestamp_Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy/
Title_Timestamp_Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy.html
Title_Timestamp_Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy.json
Title_Timestamp_Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy.txt
attachments/
avatars/
space_details.json

Below is an example of a simple room that got archived.

https://raw.githubusercontent.com/CiscoDevNet/webex-teams-archiver/master/sample.png

Note 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.

Note 2: Please note that use of the Webex Teams Archiver may violate the retention policy, if any, applicable to your use of Webex Teams.

Installation

Installing and upgrading is easy:

Install via PIP

$ pip install webexteamsarchiver

Upgrading to the latest Version

$ pip install webexteamsarchiver --upgrade

Options

The archive_room method exposes the following options:

Argument

Default Value

Description

text_format

True

Create a text version of the archive

html_format

True

Create an HTML version of the archive

json_format

True

Create a JSON version of the archive

In addition, the options kwargs supports the following additional options today:

Argument

Default Value

Description

overwrite_folder

True

Overwrite the archive folder if it already exists

delete_folder

False

Delete the archive folder when done

reverse_order

True

Order messages by most recent on the bottom

download_attachments

True

Download attachments sent to the room

download_avatars

True

Download avatar images

download_workers

15

Number of download workers for downloading files

timestamp_format

%Y-%m-%dT%H:%M:%S

Timestamp strftime format

file_format

gztar

Archive file format

Questions, Support & Discussion

webexteamsarchiver is a community developed and community supported project. Feedback, thoughts, questions, issues can be submitted using the issues page.

Contribution

webexteamsarchiver is a community developed project. Code contributions are welcome via PRs!

Copyright (c) 2018-2019 Cisco and/or its affiliates.

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

webexteamsarchiver-0.9.1.tar.gz (1.5 MB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page