Skip to content

Commit 5ca450c

Browse files
committed
Update README
Include info on the ciscosparapi to webexteamssdk migration.
1 parent 540c660 commit 5ca450c

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.rst

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
webexteamssdk
33
=============
44

5-
*Simple, lightweight, scalable Python API wrapper for the Webex Teams APIs*
5+
*Work with the Webex Teams APIs in native Python!*
66

77
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
88
:target: https://github.com/CiscoDevNet/webexteamssdk/blob/master/LICENSE
@@ -15,6 +15,24 @@ webexteamssdk
1515

1616
-------------------------------------------------------------------------------
1717

18+
19+
Looking for **``ciscosparkapi``**? You are in the right place. ``ciscosparkapi`` is now ``webexteamssdk``! It still has all of the native and natural Webex Teams Python functionality that you love and now we have made room for even more functionality to be added in the future.
20+
21+
We will maintain the ``ciscosparkapi`` package (bug fixes, etc.) in the `ciscosparkapi`_ branch of this repository and continue to publish package updates with these fixes to PyPI (through the;nd of 2019). Maintaining the ``ciscosparkapi`` package should keep your code and projects up and running while giving you 12+ months to migrate your code to the new ``webexteamssdk`` library.
22+
23+
*Migration Note:* Migrating should be easy. The ``WebexTeamsAPI`` class and the Python objects returned by the API calls are nearly identical to their ``CiscoSparkAPI`` predecessors. Does the word "nearly" scare you? Here are some specifics:
24+
25+
* The obvious top-level name change from ``CiscoSparkAPI`` to ``WebexTeamsAPI``.
26+
* ``WebexTeamsAPI``'s API structure: method and attribute names are *identical*.
27+
* The returned Python objects (now derivatives of an `ImmutableData` base class) are now immutable; so you can use them in sets and as keys in dictionaries.
28+
* ``WebexTeamsAPI`` converts object attributes that contain data-time strings (like a room's creation date) to Python ``datetime``'s (actually a derived class that has been customized to model the Webex Teams data-time format)
29+
30+
There is also some new functionality under the hood that we will document, communicate, and generally make available in the future.
31+
32+
33+
-------------------------------------------------------------------------------
34+
35+
1836
**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!
1937

2038
.. code-block:: python
@@ -139,6 +157,7 @@ webexteamssdk_ is a community development projects. Feedback, thoughts, ideas,
139157
*Copyright (c) 2016-2018 Cisco and/or its affiliates.*
140158

141159

160+
.. _ciscosparkapi: https://github.com/CiscoDevNet/ciscosparkapi/tree/ciscosparkapi
142161
.. _Introduction: http://webexteamssdk.readthedocs.io/en/latest/user/intro.html
143162
.. _pagination: https://developer.webex.com/pagination.html
144163
.. _webexteamssdk.readthedocs.io: https://webexteamssdk.readthedocs.io

0 commit comments

Comments
 (0)