Skip to content

Commit defb05f

Browse files
cmlcciecmlccie
committed
refactor: Initial rebranding Webex Teams -> Webex
1 parent cebaba1 commit defb05f

File tree

116 files changed

+1047
-1050
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

116 files changed

+1047
-1050
lines changed

‎.github/workflows/build-and-test.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,18 @@ jobs:
2424
- name: Get Webex Token
2525
id: webex_token
2626
run: |
27-
WEBEX_TEAMS_ACCESS_TOKEN=$(curl -s ${{ secrets.WEBEX_TOKEN_KEEPER_URL }} | jq -r .access_token)
28-
echo "WEBEX_TEAMS_ACCESS_TOKEN=$WEBEX_TEAMS_ACCESS_TOKEN" >> "$GITHUB_OUTPUT"
29-
echo "::add-mask::$WEBEX_TEAMS_ACCESS_TOKEN"
27+
WEBEX_ACCESS_TOKEN=$(curl -s ${{ secrets.WEBEX_TOKEN_KEEPER_URL }} | jq -r .access_token)
28+
echo "WEBEX_ACCESS_TOKEN=$WEBEX_ACCESS_TOKEN" >> "$GITHUB_OUTPUT"
29+
echo "::add-mask::$WEBEX_ACCESS_TOKEN"
3030
- name: Build and Test
3131
run: script/ci
3232
env:
33-
WEBEX_TEAMS_ACCESS_TOKEN: ${{ steps.webex_token.outputs.WEBEX_TEAMS_ACCESS_TOKEN }}
34-
WEBEX_TEAMS_TEST_DOMAIN: ${{ vars.WEBEX_TEAMS_TEST_DOMAIN }}
35-
WEBEX_TEAMS_TEST_ID_START: ${{ vars.WEBEX_TEAMS_TEST_ID_START }}
36-
WEBEX_TEAMS_TEST_FILE_URL: ${{ vars.WEBEX_TEAMS_TEST_FILE_URL }}
37-
WEBEX_TEAMS_GUEST_ISSUER_ID: ${{ secrets.WEBEX_TEAMS_GUEST_ISSUER_ID }}
38-
WEBEX_TEAMS_GUEST_ISSUER_SECRET: ${{ secrets.WEBEX_TEAMS_GUEST_ISSUER_SECRET }}
33+
WEBEX_ACCESS_TOKEN: ${{ steps.webex_token.outputs.WEBEX_ACCESS_TOKEN }}
34+
WEBEX_TEST_DOMAIN: ${{ vars.WEBEX_TEST_DOMAIN }}
35+
WEBEX_TEST_ID_START: ${{ vars.WEBEX_TEST_ID_START }}
36+
WEBEX_TEST_FILE_URL: ${{ vars.WEBEX_TEST_FILE_URL }}
37+
WEBEX_GUEST_ISSUER_ID: ${{ secrets.WEBEX_GUEST_ISSUER_ID }}
38+
WEBEX_GUEST_ISSUER_SECRET: ${{ secrets.WEBEX_GUEST_ISSUER_SECRET }}
3939
- name: Upload Distribution Files
4040
uses: actions/upload-artifact@v4
4141
with:

‎README.rst

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,49 @@
11
=============
2-
webexteamssdk
2+
webexpythonsdk
33
=============
44

55
*Work with the Webex APIs in native Python!*
66

77
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
88
:target: https://github.com/WebexCommunity/WebexPythonSDK/blob/master/LICENSE
9-
.. image:: https://img.shields.io/pypi/v/webexteamssdk.svg
10-
:target: https://pypi.org/project/webexteamssdk/
11-
.. image:: https://img.shields.io/pypi/dw/webexteamssdk.svg
12-
:target: https://pypi.org/project/webexteamssdk/
13-
.. image:: https://readthedocs.org/projects/webexteamssdk/badge/?version=latest
14-
:target: http://webexteamssdk.readthedocs.io/en/latest/?badge=latest
9+
.. image:: https://img.shields.io/pypi/v/webexpythonsdk.svg
10+
:target: https://pypi.org/project/webexpythonsdk/
11+
.. image:: https://img.shields.io/pypi/dw/webexpythonsdk.svg
12+
:target: https://pypi.org/project/webexpythonsdk/
13+
.. image:: https://readthedocs.org/projects/webexpythonsdk/badge/?version=latest
14+
:target: http://webexpythonsdk.readthedocs.io/en/latest/?badge=latest
1515

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

1818

19-
**webexteamssdk** v1.7 will be the last 🤞 release of the `webexteamssdk` package. This will be the last release
19+
**webexpythonsdk** v1.7 will be the last 🤞 release of the `webexpythonsdk` package. This will be the last release
2020
supporting Python v2 and v3 compatibility; it is compatible Python v3 releases *up to Python v3.10*.
2121

22-
Going forward, the `webexteamssdk` package will be replaced by the `WebexPythonSDK` package, which will support Python
22+
Going forward, the `webexpythonsdk` package will be replaced by the `WebexPythonSDK` package, which will support Python
2323
v3.10+.
2424

2525
------------------------------------------------------------------------------------------------------------------------
2626

2727

28-
**webexteamssdk** is a *community developed* Python library for working with the Webex APIs. Our goal is to make
28+
**webexpythonsdk** is a *community developed* Python library for working with the Webex APIs. Our goal is to make
2929
working with Webex in Python a *native* and *natural* experience!
3030

3131
.. code-block:: Python
3232
33-
from webexteamssdk import WebexTeamsAPI
33+
from webexpythonsdk import WebexAPI
3434
35-
api = WebexTeamsAPI()
35+
api = WebexAPI()
3636
37-
# Find all rooms that have 'webexteamssdk Demo' in their title
37+
# Find all rooms that have 'webexpythonsdk Demo' in their title
3838
all_rooms = api.rooms.list()
39-
demo_rooms = [room for room in all_rooms if 'webexteamssdk Demo' in room.title]
39+
demo_rooms = [room for room in all_rooms if 'webexpythonsdk Demo' in room.title]
4040
4141
# Delete all of the demo rooms
4242
for room in demo_rooms:
4343
api.rooms.delete(room.id)
4444
4545
# Create a new demo room
46-
demo_room = api.rooms.create('webexteamssdk Demo')
46+
demo_room = api.rooms.create('webexpythonsdk Demo')
4747
4848
# Add people to the new demo room
4949
email_addresses = ["test01@cmlccie.com", "test02@cmlccie.com"]
@@ -52,21 +52,21 @@ working with Webex in Python a *native* and *natural* experience!
5252
5353
# Post a message to the new room, and upload a file
5454
api.messages.create(demo_room.id, text="Welcome to the room!",
55-
files=["https://www.webex.com/content/dam/wbx/us/images/dg-integ/teams_icon.png"])
55+
files=["https://www.webex.com/content/dam/wbx/us/images/navigation/CiscoWebex-Logo_white.png"])
5656
5757
5858
That's more than 6 Webex API calls in less than 23 lines of code (with comments and whitespace), and likely more
59-
than that, since webexteamssdk handles pagination_ for you automatically!
59+
than that, since webexpythonsdk handles pagination_ for you automatically!
6060

61-
webexteamssdk makes your life better... `Learn how!`__
61+
webexpythonsdk makes your life better... `Learn how!`__
6262

6363
__ Introduction_
6464

6565

6666
Features
6767
--------
6868

69-
webexteamssdk does all of this for you:
69+
webexpythonsdk does all of this for you:
7070

7171
* Transparently sources your Webex access token from your local environment
7272

@@ -75,9 +75,9 @@ webexteamssdk does all of this for you:
7575

7676
* Represents all Webex API interactions using native Python tools
7777

78-
* Authentication and Connection to the Webex Cloud ==> **WebexTeamsAPI** "connection object"
78+
* Authentication and Connection to the Webex Cloud ==> **WebexAPI** "connection object"
7979

80-
* API Calls ==> Hierarchically organized methods underneath the **WebexTeamsAPI** 'Connection Object'
80+
* API Calls ==> Hierarchically organized methods underneath the **WebexAPI** 'Connection Object'
8181

8282
* Returned Data Objects ==> Native Python objects
8383

@@ -93,28 +93,28 @@ webexteamssdk does all of this for you:
9393
Installation
9494
------------
9595

96-
Installing and upgrading webexteamssdk is easy:
96+
Installing and upgrading webexpythonsdk is easy:
9797

9898
**Install via PIP**
9999

100100
.. code-block:: bash
101101
102-
$ pip install webexteamssdk
102+
$ pip install webexpythonsdk
103103
104104
**Upgrade to the latest version**
105105

106106
.. code-block:: bash
107107
108-
$ pip install webexteamssdk --upgrade
108+
$ pip install webexpythonsdk --upgrade
109109
110110
111111
Documentation
112112
-------------
113113

114114
**Excellent documentation is now available at:**
115-
http://webexteamssdk.readthedocs.io
115+
http://webexpythonsdk.readthedocs.io
116116

117-
Check out the Quickstart_ to dive in and begin using webexteamssdk.
117+
Check out the Quickstart_ to dive in and begin using webexpythonsdk.
118118

119119

120120
Examples
@@ -137,10 +137,10 @@ published releases.
137137
Questions, Support & Discussion
138138
-------------------------------
139139

140-
webexteamssdk is a *community developed* and *community-supported* project. If you experience any issues using this
140+
webexpythonsdk is a *community developed* and *community-supported* project. If you experience any issues using this
141141
package, please report them using the issues_ page.
142142

143-
Please join the `Python Webex Teams Devs`__ Webex space to ask questions, join the discussion, and share your
143+
Please join the `Python Webex Devs`__ Webex space to ask questions, join the discussion, and share your
144144
projects and creations.
145145

146146
__ Community_
@@ -149,14 +149,14 @@ __ Community_
149149
Contribution
150150
------------
151151

152-
webexteamssdk is a community development project. Feedback, thoughts, ideas, and code contributions are welcome!
152+
webexpythonsdk is a community development project. Feedback, thoughts, ideas, and code contributions are welcome!
153153
Please see the `Contributing`_ guide for more information.
154154

155155

156156
History
157157
-------
158158

159-
The Webex Python SDK (webexteamssdk) library started as Cisco Spark API (ciscosparkapi). We updated the library's name in
159+
The Webex Python SDK (webexpythonsdk) library started as Cisco Spark API (ciscosparkapi). We updated the library's name in
160160
alignment with Cisco's re-brand of Cisco Spark to Webex. The Cisco Spark API library has been deprecated and is no
161161
longer supported; however, its open-source codebase is still available in the `ciscosparkapi`_ branch of this
162162
repository.
@@ -168,19 +168,19 @@ developer.webex.com.
168168
*Copyright (c) 2016-2024 Cisco and/or its affiliates.*
169169

170170

171-
.. _Release Plan: https://github.com/CiscoDevNet/webexteamssdk/wiki/Release-Plans
172-
.. _Introduction: http://webexteamssdk.readthedocs.io/en/latest/user/intro.html
171+
.. _Release Plan: https://github.com/WebexCommunity/WebexPythonSDK/wiki/Release-Plans
172+
.. _Introduction: http://webexpythonsdk.readthedocs.io/en/latest/user/intro.html
173173
.. _pagination: https://developer.webex.com/docs/basics#pagination
174-
.. _webexteamssdk.readthedocs.io: https://webexteamssdk.readthedocs.io
175-
.. _Quickstart: http://webexteamssdk.readthedocs.io/en/latest/user/quickstart.html
176-
.. _examples: https://github.com/CiscoDevNet/webexteamssdk/tree/master/examples
177-
.. _webexteamssdk: https://github.com/CiscoDevNet/webexteamssdk
178-
.. _issues: https://github.com/CiscoDevNet/webexteamssdk/issues
174+
.. _webexpythonsdk.readthedocs.io: https://webexpythonsdk.readthedocs.io
175+
.. _Quickstart: http://webexpythonsdk.readthedocs.io/en/latest/user/quickstart.html
176+
.. _examples: https://github.com/WebexCommunity/WebexPythonSDK/tree/master/examples
177+
.. _webexpythonsdk: https://github.com/WebexCommunity/WebexPythonSDK
178+
.. _issues: https://github.com/WebexCommunity/WebexPythonSDK/issues
179179
.. _Community: https://eurl.io/#HkMxO-_9-
180-
.. _projects: https://github.com/CiscoDevNet/webexteamssdk/projects
181-
.. _pull requests: https://github.com/CiscoDevNet/webexteamssdk/pulls
182-
.. _releases: https://github.com/CiscoDevNet/webexteamssdk/releases
183-
.. _the repository: webexteamssdk_
180+
.. _projects: https://github.com/WebexCommunity/WebexPythonSDK/projects
181+
.. _pull requests: https://github.com/WebexCommunity/WebexPythonSDK/pulls
182+
.. _releases: https://github.com/WebexCommunity/WebexPythonSDK/releases
183+
.. _the repository: webexpythonsdk_
184184
.. _pull request: `pull requests`_
185-
.. _Contributing: https://github.com/CiscoDevNet/webexteamssdk/blob/master/docs/contributing.rst
185+
.. _Contributing: https://github.com/WebexCommunity/WebexPythonSDK/blob/master/docs/contributing.rst
186186
.. _ciscosparkapi: https://github.com/CiscoDevNet/ciscosparkapi/tree/ciscosparkapi

‎docs/Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,9 @@ qthelp:
9191
@echo
9292
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
9393
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
94-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/webexteamssdk.qhcp"
94+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/webexpythonsdk.qhcp"
9595
@echo "To view the help file:"
96-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/webexteamssdk.qhc"
96+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/webexpythonsdk.qhc"
9797

9898
.PHONY: applehelp
9999
applehelp:
@@ -110,8 +110,8 @@ devhelp:
110110
@echo
111111
@echo "Build finished."
112112
@echo "To view the help file:"
113-
@echo "# mkdir -p $$HOME/.local/share/devhelp/webexteamssdk"
114-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/webexteamssdk"
113+
@echo "# mkdir -p $$HOME/.local/share/devhelp/webexpythonsdk"
114+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/webexpythonsdk"
115115
@echo "# devhelp"
116116

117117
.PHONY: epub

‎docs/conf.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
sys.path.insert(0, os.path.abspath(".."))
88

99

10-
from webexteamssdk._version import get_versions
10+
from webexpythonsdk._version import get_versions
1111

1212

13-
project = "webexteamssdk"
13+
project = "webexpythonsdk"
1414
copyright = "Copyright (c) 2016-2024 Cisco and/or its affiliates."
1515
author = "Chris Lunsford"
1616
version = get_versions()["version"]
@@ -74,7 +74,7 @@
7474
# The name for this set of Sphinx documents.
7575
# "<project> v<release> documentation" by default.
7676
#
77-
# html_title = u'webexteamssdk vv0.3'
77+
# html_title = u'webexpythonsdk vv0.3'
7878

7979
# A shorter title for the navigation bar. Default is the same as html_title.
8080
#
@@ -174,7 +174,7 @@
174174
# html_search_scorer = 'scorer.js'
175175

176176
# Output file base name for HTML help builder.
177-
htmlhelp_basename = "webexteamssdkdoc"
177+
htmlhelp_basename = "webexpythonsdkdoc"
178178

179179

180180
# -- Options for LaTeX output ---------------------------------------------
@@ -200,8 +200,8 @@
200200
latex_documents = [
201201
(
202202
master_doc,
203-
"webexteamssdk.tex",
204-
"webexteamssdk Documentation",
203+
"webexpythonsdk.tex",
204+
"webexpythonsdk Documentation",
205205
"Chris Lunsford",
206206
"manual",
207207
),
@@ -245,7 +245,7 @@
245245
# One entry per manual page. List of tuples
246246
# (source start file, name, description, authors, manual section).
247247
man_pages = [
248-
(master_doc, "webexteamssdk", "webexteamssdk Documentation", [author], 1)
248+
(master_doc, "webexpythonsdk", "webexpythonsdk Documentation", [author], 1)
249249
]
250250

251251
# If true, show URL addresses after external links.
@@ -261,10 +261,10 @@
261261
texinfo_documents = [
262262
(
263263
master_doc,
264-
"webexteamssdk",
265-
"webexteamssdk Documentation",
264+
"webexpythonsdk",
265+
"webexpythonsdk Documentation",
266266
author,
267-
"webexteamssdk",
267+
"webexpythonsdk",
268268
"One line description of project.",
269269
"Miscellaneous",
270270
),

‎docs/contributing.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
Contributing
55
============
66

7-
*webexteamssdk* is a community development project. Feedback, thoughts, ideas, and code contributions are most welcome!
7+
*webexpythonsdk* is a community development project. Feedback, thoughts, ideas, and code contributions are most welcome!
88

99

1010
How to contribute Feedback, Issues, Thoughts and Ideas
1111
=======================================================
1212

1313
Please use the `issues`_ page to report issues or post ideas for enhancement.
1414

15-
Join our `webexteamssdk - Webex Teams SDK - Python Community Contributors <https://eurl.io/#BJ0A8gfOQ>`_ Webex Teams space to join the conversation with other contributors to this project.
15+
Join our `Webex Python SDK - Python Community Contributors <https://eurl.io/#BJ0A8gfOQ>`_ Webex space to join the conversation with other contributors to this project.
1616

1717

1818

@@ -29,7 +29,7 @@ We have created some scripts to automate everyday actions needed when working on
2929
Notes on the Test Suite
3030
-----------------------
3131

32-
To test all the API endpoints, the account that you use for testing must be an *admin* user for your Webex Teams Organization. Additionally, you should know that that the testing process creates some test people, rooms, messages, teams, and etc. as part of executing the test suite. We strongly recommend *NOT* running the test suite using your personal Webex Teams account (not that you can't; it's just that you probably don't want it cluttering your account with all these test artifacts).
32+
To test all the API endpoints, the account that you use for testing must be an *admin* user for your Webex Organization. Additionally, you should know that that the testing process creates some test people, rooms, messages, teams, and etc. as part of executing the test suite. We strongly recommend *NOT* running the test suite using your personal Webex account (not that you can't; it's just that you probably don't want it cluttering your account with all these test artifacts).
3333

3434
If you cannot create a test account with *admin* privileges or configure your environment to run the test suite locally, you may always submit your code via a pull request. We will test your code before merging and releasing the changes.
3535

@@ -45,7 +45,7 @@ Contributing Code
4545

4646
4. Configure the following environment variables in your development environment:
4747

48-
* ``WEBEX_TEAMS_ACCESS_TOKEN`` - Your test account's Webex Teams access token.
48+
* ``WEBEX_ACCESS_TOKEN`` - Your test account's Webex access token.
4949

5050
5. Add your code to your forked repository.
5151

@@ -65,30 +65,30 @@ Running the Test Suite Locally
6565

6666
Configure the following environment variables in your development environment:
6767

68-
* ``WEBEX_TEAMS_ACCESS_TOKEN`` - Your test account's Webex Teams access token.
68+
* ``WEBEX_ACCESS_TOKEN`` - Your test account's Webex access token.
6969

70-
* ``WEBEX_TEAMS_TEST_DOMAIN`` - The test suite creates some users as part of the testing process. The test suite uses this domain name as the e-mail suffix of for the user's e-mail addresses.
70+
* ``WEBEX_TEST_DOMAIN`` - The test suite creates some users as part of the testing process. The test suite uses this domain name as the e-mail suffix of for the user's e-mail addresses.
7171

72-
* ``WEBEX_TEAMS_TEST_ID_START`` - The test suite uses this integer as the starting number for creating test user accounts (example: "test42@domain.com").
72+
* ``WEBEX_TEST_ID_START`` - The test suite uses this integer as the starting number for creating test user accounts (example: "test42@domain.com").
7373

74-
* ``WEBEX_TEAMS_TEST_FILE_URL`` - Configure this environment variable with a URL referencing a file that can be downloaded and posted to Webex Teams as part of the testing process.
74+
* ``WEBEX_TEST_FILE_URL`` - Configure this environment variable with a URL referencing a file that can be downloaded and posted to Webex as part of the testing process.
7575

7676
*Example:*
7777

7878
.. code-block:: bash
7979
8080
#!/usr/bin/env bash
81-
export WEBEX_TEAMS_ACCESS_TOKEN="<test account's access token>"
82-
export WEBEX_TEAMS_TEST_DOMAIN="domain.com"
83-
export WEBEX_TEAMS_TEST_ID_START=42
84-
export WEBEX_TEAMS_TEST_FILE_URL="https://www.webex.com/content/dam/wbx/us/images/dg-integ/teams_icon.png"
81+
export WEBEX_ACCESS_TOKEN="<test account's access token>"
82+
export WEBEX_TEST_DOMAIN="domain.com"
83+
export WEBEX_TEST_ID_START=42
84+
export WEBEX_TEST_FILE_URL="https://www.webex.com/content/dam/wbx/us/images/navigation/CiscoWebex-Logo_white.png"
8585
8686
Ensure your code passes all of the default tests. Run ``script/test`` and ensure all tests execute successfully.
8787

8888

89-
.. _script: https://github.com/CiscoDevNet/webexteamssdk/tree/master/script
90-
.. _issues: https://github.com/CiscoDevNet/webexteamssdk/issues
91-
.. _repository: https://github.com/CiscoDevNet/webexteamssdk
92-
.. _test: https://github.com/CiscoDevNet/webexteamssdk/tree/master/tests
89+
.. _script: https://github.com/WebexCommunity/WebexPythonSDK/tree/master/script
90+
.. _issues: https://github.com/WebexCommunity/WebexPythonSDK/issues
91+
.. _repository: https://github.com/WebexCommunity/WebexPythonSDK
92+
.. _test: https://github.com/WebexCommunity/WebexPythonSDK/tree/master/tests
9393
.. _PEP8: https://www.python.org/dev/peps/pep-0008/
94-
.. _pull request: https://github.com/CiscoDevNet/webexteamssdk/pulls
94+
.. _pull request: https://github.com/WebexCommunity/WebexPythonSDK/pulls

0 commit comments

Comments
 (0)