Simple, lightweight, scalable Python API wrapper for the Cisco Spark APIs


Keywords
cisco spark api enterprise messaging, cisco, cisco-spark-bot, python, python-library, python-sdk, python-wrapper, python2, python3, webex, webex-teams, webex-teams-bot, webex-teams-sdk
License
MIT
Install
pip install ciscosparkapi==0.10.1

Documentation

webexteamssdk

Work with the Webex Teams APIs in native Python!

https://travis-ci.org/CiscoDevNet/webexteamssdk.svg?branch=master https://readthedocs.org/projects/webexteamssdk/badge/?version=latest

With release v1.6 we are wrapping up active development on the v1.x release and shifting our focus to the next major release v2! Please see the work-in-progress Release Plan and contribute your ideas for v2.x enhancements by either opening enhancement issues or by joining our webexteamssdk - Webex Teams SDK - Python Community Contributors space and posting your ideas there.


webexteamssdk is a community developed Python library for working with the Webex Teams APIs. Our goal is to make working with Webex Teams in Python a native and natural experience!

from webexteamssdk import WebexTeamsAPI

api = WebexTeamsAPI()

# Find all rooms that have 'webexteamssdk Demo' in their title
all_rooms = api.rooms.list()
demo_rooms = [room for room in all_rooms if 'webexteamssdk Demo' in room.title]

# Delete all of the demo rooms
for room in demo_rooms:
    api.rooms.delete(room.id)

# Create a new demo room
demo_room = api.rooms.create('webexteamssdk Demo')

# Add people to the new demo room
email_addresses = ["test01@cmlccie.com", "test02@cmlccie.com"]
for email in email_addresses:
    api.memberships.create(demo_room.id, personEmail=email)

# Post a message to the new room, and upload a file
api.messages.create(demo_room.id, text="Welcome to the room!",
                    files=["https://www.webex.com/content/dam/wbx/us/images/dg-integ/teams_icon.png"])

That's more than 6 Webex Teams API calls in less than 23 lines of code (with comments and whitespace), and likely more than that, since webexteamssdk handles pagination for you automatically!

webexteamssdk makes your life better... Learn how!

Features

webexteamssdk does all of this for you:

  • Transparently sources your Webex Teams access token from your local environment
  • Provides and uses default arguments and settings everywhere possible, so you don't have to think about things like API endpoint URLs, HTTP headers and JSON formats
  • Represents all Webex Teams API interactions using native Python tools
    • Authentication and Connection to the Webex Teams Cloud ==> WebexTeamsAPI "connection object"
    • API Calls ==> Hierarchically organized methods underneath the WebexTeamsAPI 'Connection Object'
    • Returned Data Objects ==> Native Python objects
  • Automatic and transparent pagination!
  • Automatic rate-limit handling! (wait|retry)
  • Multipart encoding and uploading of local files
  • Auto-completion in your favorite IDE, descriptive exceptions, and so much more...

Installation

Installing and upgrading webexteamssdk is easy:

Install via PIP

$ pip install webexteamssdk

Upgrade to the latest version

$ pip install webexteamssdk --upgrade

Documentation

Excellent documentation is now available at: http://webexteamssdk.readthedocs.io

Check out the Quickstart to dive in and begin using webexteamssdk.

Examples

Are you looking for some sample scripts? Check out the examples folder!

Have a good example script you would like to share? Please feel free to contribute!

Release Notes

Please see the releases page for release notes on the incremental functionality and bug fixes incorporated into the published releases.

Questions, Support & Discussion

webexteamssdk is a community developed and community-supported project. If you experience any issues using this package, please report them using the issues page.

Please join the Python Webex Teams Devs Webex Teams space to ask questions, join the discussion, and share your projects and creations.

Contribution

webexteamssdk is a community development project. Feedback, thoughts, ideas, and code contributions are welcome! Please see the Contributing guide for more information.

History

The Webex Teams SDK (webexteamssdk) library started as Cisco Spark API (ciscosparkapi). We updated the library's name in alignment with Cisco's re-brand of Cisco Spark to Webex Teams. The Cisco Spark API library has been deprecated and is no longer supported; however, its open-source codebase is still available in the ciscosparkapi branch of this repository.

The development team may make additional name changes as the library evolves with the Webex APIs published on developer.webex.com.

Copyright (c) 2016-2020 Cisco and/or its affiliates.