=============
webexteamssdk
=============
*Work with the Webex APIs in native Python!*
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://github.com/WebexCommunity/WebexPythonSDK/blob/master/LICENSE
.. image:: https://img.shields.io/pypi/v/webexteamssdk.svg
:target: https://pypi.org/project/webexteamssdk/
.. image:: https://img.shields.io/pypi/dw/webexteamssdk.svg
:target: https://pypi.org/project/webexteamssdk/
.. image:: https://readthedocs.org/projects/webexteamssdk/badge/?version=latest
:target: http://webexteamssdk.readthedocs.io/en/latest/?badge=latest
------------------------------------------------------------------------------------------------------------------------
**webexteamssdk** v1.7 will be the last 🤞 release of the `webexteamssdk` package. This will be the last release
supporting Python v2 and v3 compatibility; it is compatible Python v3 releases *up to Python v3.10*.
Going forward, the `webexteamssdk` package will be replaced by the `WebexPythonSDK` package, which will support Python
v3.10+.
------------------------------------------------------------------------------------------------------------------------
**webexteamssdk** is a *community developed* Python library for working with the Webex APIs. Our goal is to make
working with Webex in Python a *native* and *natural* experience!
.. code-block:: Python
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 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!`__
__ Introduction_
Features
--------
webexteamssdk does all of this for you:
* Transparently sources your Webex 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 API interactions using native Python tools
* Authentication and Connection to the Webex 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**
.. code-block:: bash
$ pip install webexteamssdk
**Upgrade to the latest version**
.. code-block:: bash
$ 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`__!
__ Contribution_
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 space to ask questions, join the discussion, and share your
projects and creations.
__ Community_
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 Python 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. 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-2024 Cisco and/or its affiliates.*
.. _Release Plan: https://github.com/CiscoDevNet/webexteamssdk/wiki/Release-Plans
.. _Introduction: http://webexteamssdk.readthedocs.io/en/latest/user/intro.html
.. _pagination: https://developer.webex.com/docs/basics#pagination
.. _webexteamssdk.readthedocs.io: https://webexteamssdk.readthedocs.io
.. _Quickstart: http://webexteamssdk.readthedocs.io/en/latest/user/quickstart.html
.. _examples: https://github.com/CiscoDevNet/webexteamssdk/tree/master/examples
.. _webexteamssdk: https://github.com/CiscoDevNet/webexteamssdk
.. _issues: https://github.com/CiscoDevNet/webexteamssdk/issues
.. _Community: https://eurl.io/#HkMxO-_9-
.. _projects: https://github.com/CiscoDevNet/webexteamssdk/projects
.. _pull requests: https://github.com/CiscoDevNet/webexteamssdk/pulls
.. _releases: https://github.com/CiscoDevNet/webexteamssdk/releases
.. _the repository: webexteamssdk_
.. _pull request: `pull requests`_
.. _Contributing: https://github.com/CiscoDevNet/webexteamssdk/blob/master/docs/contributing.rst
.. _ciscosparkapi: https://github.com/CiscoDevNet/ciscosparkapi/tree/ciscosparkapi
Raw data
{
"_id": null,
"home_page": "https://github.com/CiscoDevNet/webexteamssdk",
"name": "webexteamssdk",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "cisco webex teams spark python api sdk enterprise messaging",
"author": "Chris Lunsford",
"author_email": "chrlunsf@cisco.com",
"download_url": "https://files.pythonhosted.org/packages/49/fc/aee8a90e9db4b36c6d183fb81a9778eb2ac68ecee8bdf5838f4896cbca4b/webexteamssdk-1.7.tar.gz",
"platform": null,
"description": "=============\nwebexteamssdk\n=============\n\n*Work with the Webex APIs in native Python!*\n\n.. image:: https://img.shields.io/badge/license-MIT-blue.svg\n :target: https://github.com/WebexCommunity/WebexPythonSDK/blob/master/LICENSE\n.. image:: https://img.shields.io/pypi/v/webexteamssdk.svg\n :target: https://pypi.org/project/webexteamssdk/\n.. image:: https://img.shields.io/pypi/dw/webexteamssdk.svg\n :target: https://pypi.org/project/webexteamssdk/\n.. image:: https://readthedocs.org/projects/webexteamssdk/badge/?version=latest\n :target: http://webexteamssdk.readthedocs.io/en/latest/?badge=latest\n\n------------------------------------------------------------------------------------------------------------------------\n\n\n**webexteamssdk** v1.7 will be the last \ud83e\udd1e release of the `webexteamssdk` package. This will be the last release\nsupporting Python v2 and v3 compatibility; it is compatible Python v3 releases *up to Python v3.10*.\n\nGoing forward, the `webexteamssdk` package will be replaced by the `WebexPythonSDK` package, which will support Python\nv3.10+.\n\n------------------------------------------------------------------------------------------------------------------------\n\n\n**webexteamssdk** is a *community developed* Python library for working with the Webex APIs. Our goal is to make\nworking with Webex in Python a *native* and *natural* experience!\n\n.. code-block:: Python\n\n from webexteamssdk import WebexTeamsAPI\n\n api = WebexTeamsAPI()\n\n # Find all rooms that have 'webexteamssdk Demo' in their title\n all_rooms = api.rooms.list()\n demo_rooms = [room for room in all_rooms if 'webexteamssdk Demo' in room.title]\n\n # Delete all of the demo rooms\n for room in demo_rooms:\n api.rooms.delete(room.id)\n\n # Create a new demo room\n demo_room = api.rooms.create('webexteamssdk Demo')\n\n # Add people to the new demo room\n email_addresses = [\"test01@cmlccie.com\", \"test02@cmlccie.com\"]\n for email in email_addresses:\n api.memberships.create(demo_room.id, personEmail=email)\n\n # Post a message to the new room, and upload a file\n api.messages.create(demo_room.id, text=\"Welcome to the room!\",\n files=[\"https://www.webex.com/content/dam/wbx/us/images/dg-integ/teams_icon.png\"])\n\n\nThat's more than 6 Webex API calls in less than 23 lines of code (with comments and whitespace), and likely more\nthan that, since webexteamssdk handles pagination_ for you automatically!\n\nwebexteamssdk makes your life better... `Learn how!`__\n\n__ Introduction_\n\n\nFeatures\n--------\n\nwebexteamssdk does all of this for you:\n\n* Transparently sources your Webex access token from your local environment\n\n* Provides and uses default arguments and settings everywhere possible, so you don't have to think about things like API\n endpoint URLs, HTTP headers and JSON formats\n\n* Represents all Webex API interactions using native Python tools\n\n * Authentication and Connection to the Webex Cloud ==> **WebexTeamsAPI** \"connection object\"\n\n * API Calls ==> Hierarchically organized methods underneath the **WebexTeamsAPI** 'Connection Object'\n\n * Returned Data Objects ==> Native Python objects\n\n* **Automatic and transparent pagination!**\n\n* **Automatic rate-limit handling!** *(wait|retry)*\n\n* Multipart encoding and uploading of local files\n\n* Auto-completion in your favorite IDE, descriptive exceptions, and so much more...\n\n\nInstallation\n------------\n\nInstalling and upgrading webexteamssdk is easy:\n\n**Install via PIP**\n\n.. code-block:: bash\n\n $ pip install webexteamssdk\n\n**Upgrade to the latest version**\n\n.. code-block:: bash\n\n $ pip install webexteamssdk --upgrade\n\n\nDocumentation\n-------------\n\n**Excellent documentation is now available at:**\nhttp://webexteamssdk.readthedocs.io\n\nCheck out the Quickstart_ to dive in and begin using webexteamssdk.\n\n\nExamples\n--------\n\nAre you looking for some sample scripts? Check out the examples_ folder!\n\nHave a good example script you would like to share? Please feel free to `contribute`__!\n\n__ Contribution_\n\n\nRelease Notes\n-------------\n\nPlease see the releases_ page for release notes on the incremental functionality and bug fixes incorporated into the\npublished releases.\n\n\nQuestions, Support & Discussion\n-------------------------------\n\nwebexteamssdk is a *community developed* and *community-supported* project. If you experience any issues using this\npackage, please report them using the issues_ page.\n\nPlease join the `Python Webex Teams Devs`__ Webex space to ask questions, join the discussion, and share your\nprojects and creations.\n\n__ Community_\n\n\nContribution\n------------\n\nwebexteamssdk is a community development project. Feedback, thoughts, ideas, and code contributions are welcome!\nPlease see the `Contributing`_ guide for more information.\n\n\nHistory\n-------\n\nThe Webex Python SDK (webexteamssdk) library started as Cisco Spark API (ciscosparkapi). We updated the library's name in\nalignment with Cisco's re-brand of Cisco Spark to Webex. The Cisco Spark API library has been deprecated and is no\nlonger supported; however, its open-source codebase is still available in the `ciscosparkapi`_ branch of this\nrepository.\n\nThe development team may make additional name changes as the library evolves with the Webex APIs published on\ndeveloper.webex.com.\n\n\n*Copyright (c) 2016-2024 Cisco and/or its affiliates.*\n\n\n.. _Release Plan: https://github.com/CiscoDevNet/webexteamssdk/wiki/Release-Plans\n.. _Introduction: http://webexteamssdk.readthedocs.io/en/latest/user/intro.html\n.. _pagination: https://developer.webex.com/docs/basics#pagination\n.. _webexteamssdk.readthedocs.io: https://webexteamssdk.readthedocs.io\n.. _Quickstart: http://webexteamssdk.readthedocs.io/en/latest/user/quickstart.html\n.. _examples: https://github.com/CiscoDevNet/webexteamssdk/tree/master/examples\n.. _webexteamssdk: https://github.com/CiscoDevNet/webexteamssdk\n.. _issues: https://github.com/CiscoDevNet/webexteamssdk/issues\n.. _Community: https://eurl.io/#HkMxO-_9-\n.. _projects: https://github.com/CiscoDevNet/webexteamssdk/projects\n.. _pull requests: https://github.com/CiscoDevNet/webexteamssdk/pulls\n.. _releases: https://github.com/CiscoDevNet/webexteamssdk/releases\n.. _the repository: webexteamssdk_\n.. _pull request: `pull requests`_\n.. _Contributing: https://github.com/CiscoDevNet/webexteamssdk/blob/master/docs/contributing.rst\n.. _ciscosparkapi: https://github.com/CiscoDevNet/ciscosparkapi/tree/ciscosparkapi\n\n\n",
"bugtrack_url": null,
"license": "MIT; Copyright (c) 2016-2024 Cisco and/or its affiliates.",
"summary": "Community-developed Python SDK for the Webex Teams APIs",
"version": "1.7",
"project_urls": {
"Download": "https://pypi.python.org/pypi/webexteamssdk",
"Homepage": "https://github.com/CiscoDevNet/webexteamssdk"
},
"split_keywords": [
"cisco",
"webex",
"teams",
"spark",
"python",
"api",
"sdk",
"enterprise",
"messaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "49fcaee8a90e9db4b36c6d183fb81a9778eb2ac68ecee8bdf5838f4896cbca4b",
"md5": "34c27a659510efb62d5f437a5e6b2262",
"sha256": "4cc8e7d000d5cf3e25913966bfb2af6d023b1dcc51b75e1cea19e89ebc3f1d00"
},
"downloads": -1,
"filename": "webexteamssdk-1.7.tar.gz",
"has_sig": false,
"md5_digest": "34c27a659510efb62d5f437a5e6b2262",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 73390,
"upload_time": "2024-06-14T21:39:29",
"upload_time_iso_8601": "2024-06-14T21:39:29.890676Z",
"url": "https://files.pythonhosted.org/packages/49/fc/aee8a90e9db4b36c6d183fb81a9778eb2ac68ecee8bdf5838f4896cbca4b/webexteamssdk-1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-14 21:39:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CiscoDevNet",
"github_project": "webexteamssdk",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "webexteamssdk"
}
JSON
