Skip to content

Commit 9f6c713

Browse files
cmlcciecmlccie
committed
Update README.rst
1 parent f6e76df commit 9f6c713

File tree

1 file changed

+33
-24
lines changed

1 file changed

+33
-24
lines changed

‎README.rst

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,22 @@ webexteamssdk
1515
.. image:: https://readthedocs.org/projects/webexteamssdk/badge/?version=latest
1616
:target: http://webexteamssdk.readthedocs.io/en/latest/?badge=latest
1717

18-
-------------------------------------------------------------------------------
18+
------------------------------------------------------------------------------------------------------------------------
1919

2020

21-
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.
21+
With release v1.6 we are wrapping up active development on the v1.x release and shifting our focus to the next major
22+
release v2! Please see the work-in-progress `Release Plan`__ and contribute your ideas for v2.x enhancements by either
23+
opening enhancement issues_ or by joining our
24+
`webexteamssdk - Webex Teams SDK - Python Community Contributors <https://eurl.io/#BJ0A8gfOQ>`_ space and posting your
25+
ideas there.
2226

23-
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 end 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.
27+
------------------------------------------------------------------------------------------------------------------------
2428

25-
*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:
2629

27-
* The obvious top-level name change from ``CiscoSparkAPI`` to ``WebexTeamsAPI``.
28-
* ``WebexTeamsAPI``'s API structure: method and attribute names are *identical*.
29-
* 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.
30-
* ``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)
30+
**webexteamssdk** is a *community developed* Python library for working with the Webex Teams APIs. Our goal is to make
31+
working with Webex Teams in Python a *native* and *natural* experience!
3132

32-
There is also some new functionality under the hood that we will document, communicate, and generally make available in the future.
33-
34-
35-
-------------------------------------------------------------------------------
36-
37-
38-
**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!
39-
40-
.. code-block:: python
33+
.. code-block:: Python
4134
4235
from webexteamssdk import WebexTeamsAPI
4336
@@ -64,7 +57,8 @@ There is also some new functionality under the hood that we will document, commu
6457
files=["https://www.webex.com/content/dam/wbx/us/images/dg-integ/teams_icon.png"])
6558
6659
67-
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!
60+
That's more than 6 Webex Teams API calls in less than 23 lines of code (with comments and whitespace), and likely more
61+
than that, since webexteamssdk handles pagination_ for you automatically!
6862

6963
webexteamssdk makes your life better... `Learn how!`__
7064

@@ -78,7 +72,8 @@ webexteamssdk does all of this for you:
7872

7973
* Transparently sources your Webex Teams access token from your local environment
8074

81-
* 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
75+
* Provides and uses default arguments and settings everywhere possible, so you don't have to think about things like API
76+
endpoint URLs, HTTP headers and JSON formats
8277

8378
* Represents all Webex Teams API interactions using native Python tools
8479

@@ -108,7 +103,7 @@ Installing and upgrading webexteamssdk is easy:
108103
109104
$ pip install webexteamssdk
110105
111-
**Upgrading to the latest Version**
106+
**Upgrade to the latest version**
112107

113108
.. code-block:: bash
114109
@@ -137,23 +132,37 @@ __ Contribution_
137132
Release Notes
138133
-------------
139134

140-
Please see the releases_ page for release notes on the incremental functionality and bug fixes incorporated into the published releases.
135+
Please see the releases_ page for release notes on the incremental functionality and bug fixes incorporated into the
136+
published releases.
141137

142138

143139
Questions, Support & Discussion
144140
-------------------------------
145141

146-
webexteamssdk is a *community developed* and *community supported* project. If you experience any issues using this package, please report them using the issues_ page.
142+
webexteamssdk is a *community developed* and *community-supported* project. If you experience any issues using this
143+
package, please report them using the issues_ page.
147144

148-
Please join the `Python Webex Teams Devs`__ Webex Teams space to ask questions, join the discussion, and share your projects and creations.
145+
Please join the `Python Webex Teams Devs`__ Webex Teams space to ask questions, join the discussion, and share your
146+
projects and creations.
149147

150148
__ Community_
151149

152150

153151
Contribution
154152
------------
155153

156-
webexteamssdk_ is a community development projects. Feedback, thoughts, ideas, and code contributions are welcome! Please see the `Contributing`_ guide for more information.
154+
webexteamssdk_ is a community development project. Feedback, thoughts, ideas, and code contributions are welcome!
155+
Please see the `Contributing`_ guide for more information.
156+
157+
158+
History
159+
-------
160+
161+
The Webex Teams SDK (webexteamssdk) library started as Cisco Spark API (ciscosparkapi). We updated the library's name in
162+
alignment with Cisco's re-brand of Cisco Spark to Webex Teams. The Cisco Spark API library has been deprecated and is no
163+
longer supported; however, its open-source codebase is still available in the `ciscosparkapi`_ branch of this repository.
164+
165+
The development team may make additional name changes as the library evolves with the Webex APIs published on developer.webex.com.
157166

158167

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

0 commit comments

Comments
 (0)