1
1
=============
2
- webexteamsdk
2
+ webexteamssdk
3
3
=============
4
4
5
5
*Simple, lightweight, scalable Python API wrapper for the Webex Teams APIs *
6
6
7
7
.. image :: https://img.shields.io/badge/license-MIT-blue.svg
8
- :target: https://github.com/CiscoDevNet/webexteamsdk /blob/master/LICENSE
9
- .. image :: https://img.shields.io/pypi/v/webexteamsdk .svg
10
- :target: https://pypi.python.org/pypi/webexteamsdk
11
- .. image :: https://travis-ci.org/CiscoDevNet/webexteamsdk .svg?branch=master
12
- :target: https://travis-ci.org/CiscoDevNet/webexteamsdk
13
- .. image :: https://readthedocs.org/projects/webexteamsdk /badge/?version=latest
14
- :target: http://webexteamsdk .readthedocs.io/en/latest/?badge=latest
8
+ :target: https://github.com/CiscoDevNet/webexteamssdk /blob/master/LICENSE
9
+ .. image :: https://img.shields.io/pypi/v/webexteamssdk .svg
10
+ :target: https://pypi.python.org/pypi/webexteamssdk
11
+ .. image :: https://travis-ci.org/CiscoDevNet/webexteamssdk .svg?branch=master
12
+ :target: https://travis-ci.org/CiscoDevNet/webexteamssdk
13
+ .. image :: https://readthedocs.org/projects/webexteamssdk /badge/?version=latest
14
+ :target: http://webexteamssdk .readthedocs.io/en/latest/?badge=latest
15
15
16
16
-------------------------------------------------------------------------------
17
17
18
- **webexteamsdk ** is a *community developed * Pythonic wrapping of the Cisco
18
+ **webexteamssdk ** is a *community developed * Pythonic wrapping of the Cisco
19
19
Spark APIs, which makes working with Webex Teams in Python a *native * and
20
20
*natural * experience!
21
21
22
22
.. code-block :: python
23
23
24
- from webexteamsdk import CiscoSparkAPI
24
+ from webexteamssdk import CiscoSparkAPI
25
25
26
26
api = CiscoSparkAPI()
27
27
28
- # Find all rooms that have 'webexteamsdk Demo' in their title
28
+ # Find all rooms that have 'webexteamssdk Demo' in their title
29
29
all_rooms = api.rooms.list()
30
- demo_rooms = [room for room in all_rooms if ' webexteamsdk Demo' in room.title]
30
+ demo_rooms = [room for room in all_rooms if ' webexteamssdk Demo' in room.title]
31
31
32
32
# Delete all of the demo rooms
33
33
for room in demo_rooms:
34
34
api.rooms.delete(room.id)
35
35
36
36
# Create a new demo room
37
- demo_room = api.rooms.create(' webexteamsdk Demo' )
37
+ demo_room = api.rooms.create(' webexteamssdk Demo' )
38
38
39
39
# Add people to the new demo room
40
40
@@ -47,18 +47,18 @@ Spark APIs, which makes working with Webex Teams in Python a *native* and
47
47
48
48
49
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 webexteamsdk handles
50
+ and whitespace), and likely more than that since webexteamssdk handles
51
51
pagination _ for you automatically!
52
52
53
- webexteamsdk makes your life better... `Learn how! `__
53
+ webexteamssdk makes your life better... `Learn how! `__
54
54
55
55
__ Introduction _
56
56
57
57
58
58
Features
59
59
--------
60
60
61
- webexteamsdk does all of this for you...
61
+ webexteamssdk does all of this for you...
62
62
63
63
+ Transparently sources your Spark credentials from your local environment
64
64
@@ -89,28 +89,28 @@ webexteamsdk does all of this for you...
89
89
Installation
90
90
------------
91
91
92
- Installing and upgrading webexteamsdk is easy:
92
+ Installing and upgrading webexteamssdk is easy:
93
93
94
94
**Install via PIP **
95
95
96
96
.. code-block :: bash
97
97
98
- $ pip install webexteamsdk
98
+ $ pip install webexteamssdk
99
99
100
100
**Upgrading to the latest Version **
101
101
102
102
.. code-block :: bash
103
103
104
- $ pip install webexteamsdk --upgrade
104
+ $ pip install webexteamssdk --upgrade
105
105
106
106
107
107
Documentation
108
108
-------------
109
109
110
110
**Excellent documentation is now available at: **
111
- http://webexteamsdk .readthedocs.io
111
+ http://webexteamssdk .readthedocs.io
112
112
113
- Check out the Quickstart _ to dive in and begin using webexteamsdk .
113
+ Check out the Quickstart _ to dive in and begin using webexteamssdk .
114
114
115
115
116
116
Examples
@@ -150,7 +150,7 @@ __ Community_
150
150
Contribution
151
151
------------
152
152
153
- webexteamsdk _ and it's sister project ciscosparksdk _ are community
153
+ webexteamssdk _ and it's sister project ciscosparksdk _ are community
154
154
development projects. Feedback, thoughts, ideas and code contributions are
155
155
most welcome!
156
156
@@ -175,18 +175,18 @@ Please use the issues_ log.
175
175
*Copyright (c) 2016-2018 Cisco and/or its affiliates. *
176
176
177
177
178
- .. _Introduction : http://webexteamsdk .readthedocs.io/en/latest/user/intro.html
178
+ .. _Introduction : http://webexteamssdk .readthedocs.io/en/latest/user/intro.html
179
179
.. _pagination : https://developer.ciscospark.com/pagination.html
180
- .. _ webexteamsdk .readthedocs.io : https://webexteamsdk .readthedocs.io
181
- .. _Quickstart : http://webexteamsdk .readthedocs.io/en/latest/user/quickstart.html
182
- .. _examples : https://github.com/CiscoDevNet/webexteamsdk /tree/master/examples
183
- .. _ webexteamsdk : https://github.com/CiscoDevNet/webexteamsdk
180
+ .. _ webexteamssdk .readthedocs.io : https://webexteamssdk .readthedocs.io
181
+ .. _Quickstart : http://webexteamssdk .readthedocs.io/en/latest/user/quickstart.html
182
+ .. _examples : https://github.com/CiscoDevNet/webexteamssdk /tree/master/examples
183
+ .. _ webexteamssdk : https://github.com/CiscoDevNet/webexteamssdk
184
184
.. _ciscosparksdk : https://github.com/CiscoDevNet/ciscosparksdk
185
- .. _issues : https://github.com/CiscoDevNet/webexteamsdk /issues
185
+ .. _issues : https://github.com/CiscoDevNet/webexteamssdk /issues
186
186
.. _Community : https://eurl.io/#HkMxO-_9-
187
- .. _projects : https://github.com/CiscoDevNet/webexteamsdk /projects
188
- .. _pull requests : https://github.com/CiscoDevNet/webexteamsdk /pulls
189
- .. _releases : https://github.com/CiscoDevNet/webexteamsdk /releases
187
+ .. _projects : https://github.com/CiscoDevNet/webexteamssdk /projects
188
+ .. _pull requests : https://github.com/CiscoDevNet/webexteamssdk /pulls
189
+ .. _releases : https://github.com/CiscoDevNet/webexteamssdk /releases
190
190
.. _charter : https://github.com/CiscoDevNet/spark-python-packages-team/blob/master/Charter.md
191
- .. _the repository : webexteamsdk _
191
+ .. _the repository : webexteamssdk _
192
192
.. _pull request : `pull requests `_
0 commit comments