Skip to content

Commit 686bbc4

Browse files
committed
Update README
Spark to Webex Teams name changes, updates to the contributor documents, and etc.
1 parent 376848c commit 686bbc4

File tree

1 file changed

+24
-61
lines changed

1 file changed

+24
-61
lines changed

README.rst

Lines changed: 24 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,13 @@ webexteamssdk
1515

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

18-
**webexteamssdk** is a *community developed* Pythonic wrapping of the Cisco
19-
Spark APIs, which makes working with Webex Teams in Python a *native* and
20-
*natural* experience!
18+
**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!
2119

2220
.. code-block:: python
2321
24-
from webexteamssdk import CiscoSparkAPI
22+
from webexteamssdk import WebexTeamsAPI
2523
26-
api = CiscoSparkAPI()
24+
api = WebexTeamsAPI()
2725
2826
# Find all rooms that have 'webexteamssdk Demo' in their title
2927
all_rooms = api.rooms.list()
@@ -43,12 +41,10 @@ Spark APIs, which makes working with Webex Teams in Python a *native* and
4341
4442
# Post a message to the new room, and upload a file
4543
api.messages.create(demo_room.id, text="Welcome to the room!",
46-
files=["https://developer.ciscospark.com/images/logo_spark_lg@256.png"])
44+
files=["https://www.webex.com/content/dam/wbx/us/images/dg-integ/teams_icon.png"])
4745
4846
49-
That's more than 6 Spark API calls in less than 23 lines of code (with comments
50-
and whitespace), and likely more than that since webexteamssdk handles
51-
pagination_ for you automatically!
47+
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!
5248

5349
webexteamssdk makes your life better... `Learn how!`__
5450

@@ -58,32 +54,27 @@ __ Introduction_
5854
Features
5955
--------
6056

61-
webexteamssdk does all of this for you...
57+
webexteamssdk does all of this for you:
6258

63-
+ Transparently sources your Spark credentials from your local environment
59+
* Transparently sources your Webex Teams access token from your local environment
6460

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

69-
+ Represents all Webex Teams API interactions using native Python tools
63+
* Represents all Webex Teams API interactions using native Python tools
7064

71-
+ Authentication and Connection to the Webex Teams Cloud ==>
72-
**CiscoSparkAPI** 'Connection Object'
65+
* Authentication and Connection to the Webex Teams Cloud ==> **WebexTeamsAPI** "connection object"
7366

74-
+ API Calls ==> Hierarchically organized method calls underneath a
75-
**CiscoSparkAPI** 'Connection Object'
67+
* API Calls ==> Hierarchically organized methods underneath the **WebexTeamsAPI** 'Connection Object'
7668

77-
+ Returned Data Objects ==> Native Python objects
69+
* Returned Data Objects ==> Native Python objects
7870

79-
+ **Automatic and transparent pagination!**
71+
* **Automatic and transparent pagination!**
8072

81-
+ **Automatic rate-limit handling!** *(wait|retry)*
73+
* **Automatic rate-limit handling!** *(wait|retry)*
8274

83-
+ Multipart encoding and uploading of local files
75+
* Multipart encoding and uploading of local files
8476

85-
+ Auto-completion in your favorite IDE, descriptive exceptions, and so much
86-
more...
77+
* Auto-completion in your favorite IDE, descriptive exceptions, and so much more...
8778

8879

8980
Installation
@@ -116,77 +107,49 @@ Check out the Quickstart_ to dive in and begin using webexteamssdk.
116107
Examples
117108
--------
118109

119-
Looking for some examples or sample scripts? Check out the examples_ folder!
110+
Are you looking for some sample scripts? Check out the examples_ folder!
120111

121-
Have a good example script you would like to share? Please feel free to
122-
`contribute`__!
112+
Have a good example script you would like to share? Please feel free to `contribute`__!
123113

124114
__ Contribution_
125115

126116

127117
Release Notes
128118
-------------
129119

130-
Complete and fully functional *Beta* releases have been published. Please
131-
see the releases_ page for release notes on the incremental functionality and
132-
bug fixes incorporated into the published releases.
133-
134-
**Note:** The package APIs may change, while the package is in beta.
120+
Please see the releases_ page for release notes on the incremental functionality and bug fixes incorporated into the published releases.
135121

136122

137123
Questions, Support & Discussion
138124
-------------------------------
139125

140-
This is a *community developed* and *community supported* project. If you
141-
experience any issues using this package, please report them using the
142-
issues_ log.
126+
webexteamssdk is a *community developed* and *community supported* project. If you experience any issues using this package, please report them using the issues_ page.
143127

144-
Please join the `Python Spark Devs`__ community Spark room to ask questions,
145-
join the discussion and share your projects and creations.
128+
Please join the `Python Webex Teams Devs`__ Webex Teams space to ask questions, join the discussion, and share your projects and creations.
146129

147130
__ Community_
148131

149132

150133
Contribution
151134
------------
152135

153-
webexteamssdk_ and it's sister project ciscosparksdk_ are community
154-
development projects. Feedback, thoughts, ideas and code contributions are
155-
most welcome!
156-
157-
**Feedback, issues, thoughts and ideas...**
158-
159-
Please use the issues_ log.
160-
161-
**Interested in contributing code?**
162-
163-
#. Check for open issues_ or create a new 'issue' for the item you want
164-
to work on.
165-
166-
* Assign yourself to the issue, and communicate with any others that may be
167-
working the issue.
168-
169-
#. Review the project charter_ for coding standards and practices.
170-
#. Fork a copy of `the repository`_.
171-
#. Add your code to your forked repository.
172-
#. Submit a `pull request`_.
136+
webexteamssdk_ is a community development projects. Feedback, thoughts, ideas, and code contributions are welcome! Please see the `Contributing`_ guide for more information.
173137

174138

175139
*Copyright (c) 2016-2018 Cisco and/or its affiliates.*
176140

177141

178142
.. _Introduction: http://webexteamssdk.readthedocs.io/en/latest/user/intro.html
179-
.. _pagination: https://developer.ciscospark.com/pagination.html
143+
.. _pagination: https://developer.webex.com/pagination.html
180144
.. _webexteamssdk.readthedocs.io: https://webexteamssdk.readthedocs.io
181145
.. _Quickstart: http://webexteamssdk.readthedocs.io/en/latest/user/quickstart.html
182146
.. _examples: https://github.com/CiscoDevNet/webexteamssdk/tree/master/examples
183147
.. _webexteamssdk: https://github.com/CiscoDevNet/webexteamssdk
184-
.. _ciscosparksdk: https://github.com/CiscoDevNet/ciscosparksdk
185148
.. _issues: https://github.com/CiscoDevNet/webexteamssdk/issues
186149
.. _Community: https://eurl.io/#HkMxO-_9-
187150
.. _projects: https://github.com/CiscoDevNet/webexteamssdk/projects
188151
.. _pull requests: https://github.com/CiscoDevNet/webexteamssdk/pulls
189152
.. _releases: https://github.com/CiscoDevNet/webexteamssdk/releases
190-
.. _charter: https://github.com/CiscoDevNet/spark-python-packages-team/blob/master/Charter.md
191153
.. _the repository: webexteamssdk_
192154
.. _pull request: `pull requests`_
155+
.. _Contributing: https://github.com/CiscoDevNet/webexteamssdk/blob/master/docs/contributing.rst

0 commit comments

Comments
 (0)