Metadata-Version: 1.1
Name: webexteamsarchiver
Version: 0.11.1
Summary: Room archiver utility for Webex Teams
Home-page: https://github.com/CiscoDevNet/webex-teams-archiver
Author: Felipe de Mello
Author-email: fdemello@cisco.com
License: MIT; Copyright (c) 2018 Cisco Systems, Inc.
Description: =====================
        Webex Teams Archiver
        =====================
        
        *Simple utility to archive Webex Teams rooms*
        
        .. image:: https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg
            :target: https://developer.cisco.com/codeexchange/github/repo/CiscoDevNet/webex-teams-archiver
        .. image:: https://img.shields.io/badge/license-MIT-blue.svg
            :target: https://github.com/CiscoDevNet/webex-teams-archiver/blob/master/LICENSE
        .. image:: https://img.shields.io/pypi/v/webexteamsarchiver.svg
            :target: https://pypi.python.org/pypi/webexteamsarchiver
        
        -------------------------------------------------------------------------------
        
        Webex Teams Archiver extracts the messages and files out of a Webex Teams room and saves them in text, HTML, and JSON formats.
        
        Example
        -------
        
        .. code-block:: python
        
            from webexteamsarchiver import WebexTeamsArchiver
        
            personal_token = "mytoken"
            archiver = WebexTeamsArchiver(personal_token)
            
            # room id from https://developer.webex.com/docs/api/v1/rooms/list-rooms
            room_id = "Y2lzY29zcGFyazovL3VzL1JPT00vd2ViZXh0ZWFtc2FyY2hpdmVy"
            archiver.archive_room(room_id)
            
        Produces the following files:
        
        .. code-block:: bash
        
            $ ls 
            Title_Timestamp.tgz
            Title_Timestamp
        
            $ ls Title_Timestamp/
            Title_Timestamp.html
            Title_Timestamp.json
            Title_Timestamp.txt
            attachments/
            avatars/
            space_details.json
        
        Below is an example of a simple room that got archived.
        
        .. image:: https://raw.githubusercontent.com/CiscoDevNet/webex-teams-archiver/master/sample.png
           :scale: 40 %
        
        
        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**
        
        .. code-block:: bash
        
            $ pip install webexteamsarchiver
        
        **Upgrading to the latest Version**
        
        .. code-block:: bash
        
            $ 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                                       | 
        +======================+===================+===================================================+
        | compress_folder      | True              | Compress archive folder                           |
        +----------------------+-------------------+---------------------------------------------------+
        | 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-2021 Cisco and/or its affiliates.*
        
        
        .. _webexteamsarchiver: https://github.com/CiscoDevNet/webex-teams-archiver
        .. _issues: https://github.com/CiscoDevNet/webex-teams-archiver/issues
        .. _format: https://docs.python.org/3/library/shutil.html#shutil.make_archive
        
Keywords: cisco webex teams spark python messaging
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Intended Audience :: Information Technology
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Communications
Classifier: Topic :: Communications :: Chat
