Skip to main content

Community-developed Python SDK for the Webex Teams APIs

Project description

Work with the Webex Teams APIs in native Python!

https://img.shields.io/badge/license-MIT-blue.svg https://img.shields.io/pypi/v/webexteamssdk.svg https://img.shields.io/pypi/dw/webexteamssdk.svg 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.

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

webexteamssdk-1.6.tar.gz (61.5 kB view details)

Uploaded Source

Built Distribution

webexteamssdk-1.6-py3-none-any.whl (113.3 kB view details)

Uploaded Python 3

File details

Details for the file webexteamssdk-1.6.tar.gz.

File metadata

  • Download URL: webexteamssdk-1.6.tar.gz
  • Upload date:
  • Size: 61.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for webexteamssdk-1.6.tar.gz
Algorithm Hash digest
SHA256 980f268d89187d1a157dfbadcb626fce849080a31550e549cfe838f0203b3a3d
MD5 e9e9fbf3e02e4698d9c199f97ea061bd
BLAKE2b-256 19e1c6b6f8f17d80fb2589e30e73a09fddfb3be254858950b207281de3953ea0

See more details on using hashes here.

File details

Details for the file webexteamssdk-1.6-py3-none-any.whl.

File metadata

  • Download URL: webexteamssdk-1.6-py3-none-any.whl
  • Upload date:
  • Size: 113.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for webexteamssdk-1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e4958dca3903c659fe1e0f79e38740cb2ec1ae2589599807b179c3efb356c3a2
MD5 390d2837db2063753f60265dd38f224f
BLAKE2b-256 4d2720edad1a463bd709e90ccc6be12cd5ce5db7ebeda98084143902c226adda

See more details on using hashes here.

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