You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**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!
21
19
22
20
.. code-block:: python
23
21
24
-
from webexteamssdk importCiscoSparkAPI
22
+
from webexteamssdk importWebexTeamsAPI
25
23
26
-
api =CiscoSparkAPI()
24
+
api =WebexTeamsAPI()
27
25
28
26
# Find all rooms that have 'webexteamssdk Demo' in their title
29
27
all_rooms = api.rooms.list()
@@ -43,12 +41,10 @@ Spark APIs, which makes working with Webex Teams in Python a *native* and
43
41
44
42
# Post a message to the new room, and upload a file
45
43
api.messages.create(demo_room.id, text="Welcome to the room!",
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!
52
48
53
49
webexteamssdk makes your life better... `Learn how!`__
54
50
@@ -58,32 +54,27 @@ __ Introduction_
58
54
Features
59
55
--------
60
56
61
-
webexteamssdk does all of this for you...
57
+
webexteamssdk does all of this for you:
62
58
63
-
+ Transparently sources your Spark credentials from your local environment
59
+
* Transparently sources your Webex Teams access token from your local environment
64
60
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
68
62
69
-
+ Represents all Webex Teams API interactions using native Python tools
63
+
* Represents all Webex Teams API interactions using native Python tools
70
64
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"
73
66
74
-
+ API Calls ==> Hierarchically organized method calls underneath a
75
-
**CiscoSparkAPI** 'Connection Object'
67
+
* API Calls ==> Hierarchically organized methods underneath the **WebexTeamsAPI** 'Connection Object'
+ 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...
87
78
88
79
89
80
Installation
@@ -116,77 +107,49 @@ Check out the Quickstart_ to dive in and begin using webexteamssdk.
116
107
Examples
117
108
--------
118
109
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!
120
111
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`__!
123
113
124
114
__Contribution_
125
115
126
116
127
117
Release Notes
128
118
-------------
129
119
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.
135
121
136
122
137
123
Questions, Support & Discussion
138
124
-------------------------------
139
125
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.
143
127
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.
146
129
147
130
__Community_
148
131
149
132
150
133
Contribution
151
134
------------
152
135
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.
173
137
174
138
175
139
*Copyright (c) 2016-2018 Cisco and/or its affiliates.*
0 commit comments