webex-bot 0.5.1__py2.py3-none-any.whl → 0.6.0__py2.py3-none-any.whl

webex_bot/__init__.py

@@ -1,4 +1,4 @@
 """Top-level package for Webex Bot."""
 
 __author__ = """Finbarr Brady"""
-__version__ = '0.5.1'
+__version__ = '0.6.0'

webex_bot/commands/echo.py

@@ -1,8 +1,8 @@
 import logging
 
-from webexteamssdk.models.cards import Colors, TextBlock, FontWeight, FontSize, Column, AdaptiveCard, ColumnSet, \
+from webexpythonsdk.models.cards import Colors, TextBlock, FontWeight, FontSize, Column, AdaptiveCard, ColumnSet, \
     Text, Image, HorizontalAlignment
-from webexteamssdk.models.cards.actions import Submit
+from webexpythonsdk.models.cards.actions import Submit
 
 from webex_bot.formatting import quote_info
 from webex_bot.models.command import Command

webex_bot/commands/help.py

@@ -1,8 +1,8 @@
 import logging
 
-from webexteamssdk.models.cards import Colors, TextBlock, FontWeight, FontSize, Column, AdaptiveCard, ColumnSet, \
+from webexpythonsdk.models.cards import Colors, TextBlock, FontWeight, FontSize, Column, AdaptiveCard, ColumnSet, \
     ImageSize, Image, Fact
-from webexteamssdk.models.cards.actions import Submit
+from webexpythonsdk.models.cards.actions import Submit
 
 from webex_bot.models.command import Command, COMMAND_KEYWORD_KEY
 from webex_bot.models.response import response_from_adaptive_card

webex_bot/models/command.py

@@ -9,8 +9,9 @@ COMMAND_KEYWORD_KEY = "command_keyword"
 
 class Command(ABC):
 
-    def __init__(self, command_keyword=None, chained_commands=[], card=None, help_message=None,
-                 delete_previous_message=False,
+    def __init__(self, command_keyword=None, exact_command_keyword_match=False,
+                 chained_commands=[], card=None,
+                 help_message=None, delete_previous_message=False,
                  card_callback_keyword=None, approved_rooms=None):
         """
         Create a new bot command.
@@ -25,10 +26,11 @@ class Command(ABC):
                     )
 
         @param command_keyword: (optional) Text indicating a phrase to invoke this card.
+        @param exact_command_keyword_match: If True, there will be an exact command_keyword match performed. If False, then a sub-string match will be performed. Default: False. 
         @param chained_commands: (optional) List of other commands related
         to this command. This allows multiple related cards to be added at once.
         @param card: (deprecated) A dict representation of the JSON card.
-        Prefer to use cards built in code using the webexteamssdk.models.cards classes
+        Prefer to use cards built in code using the webexpythonsdk.models.cards classes
         (see https://github.com/fbradyirl/webex_bot/blob/main/webex_bot/commands/echo.py for example)
         @param help_message: Short description of this command.
         @param delete_previous_message: If True, the card which invoked this command will be deleted. (default False)
@@ -37,6 +39,7 @@ class Command(ABC):
         @param approved_rooms: If defined, only members of these spaces will be allowed to run this command. Default: None (everyone)
         """
         self.command_keyword = command_keyword
+        self.exact_command_keyword_match = exact_command_keyword_match
         self.help_message = help_message
         self.card = card
         self.pre_card_callback = self.execute
@@ -52,7 +55,7 @@ class Command(ABC):
         if card is not None:
             log.warning(f"[{command_keyword}]. Using a card dict is now deprecated. "
                         f"Switch to use adaptive cards built in code "
-                        "using the webexteamssdk.models.cards classes (see "
+                        "using the webexpythonsdk.models.cards classes (see "
                         "https://github.com/fbradyirl/webex_bot/blob/main/webex_bot/commands/echo.py for example)")
             if 'actions' in card:
                 if len(card['actions']) > 0:

webex_bot/models/response.py

@@ -1,6 +1,6 @@
 import json
 
-from webexteamssdk.models.cards import AdaptiveCard
+from webexpythonsdk.models.cards import AdaptiveCard
 
 
 def response_from_adaptive_card(adaptive_card: AdaptiveCard):

webex_bot/webex_bot.py

@@ -2,10 +2,11 @@
 import logging
 import os
 
+import types
 import backoff
 import coloredlogs
 import requests
-import webexteamssdk
+import webexpythonsdk
 
 from webex_bot.commands.echo import EchoCommand
 from webex_bot.commands.help import HelpCommand
@@ -95,7 +96,7 @@ class WebexBot(WebexWebsocketClient):
     @backoff.on_exception(backoff.expo, requests.exceptions.ConnectionError)
     def get_me_info(self):
         """
-        Fetch me info from webexteamssdk
+        Fetch me info from webexpythonsdk
         """
         me = self.teams.people.me()
         self.bot_display_name = me.displayName
@@ -168,7 +169,7 @@ class WebexBot(WebexWebsocketClient):
                 for member in room_members:
                     if member.personEmail == user_email:
                         is_user_member = True
-            except webexteamssdk.exceptions.ApiError as apie:
+            except webexpythonsdk.exceptions.ApiError as apie:
                 log.warn(f"API error: {apie}")
         return is_user_member
 
@@ -234,10 +235,21 @@ class WebexBot(WebexWebsocketClient):
 
             if not is_card_callback_command and c.command_keyword:
                 log.debug(f"c.command_keyword: {c.command_keyword}")
-                if user_command.find(c.command_keyword) != -1:
-                    command = c
-                    # If a command was found, stop looking for others
-                    break
+                log.info(f"exact_command_keyword_match: {c.exact_command_keyword_match}")
+                log.info(f"user_command: {user_command}")
+                log.info(f"command_keyword: {c.command_keyword}")
+                if c.exact_command_keyword_match: # Check if the "exact_command_keyword_match" flag is set to True
+                    if user_command == c.command_keyword:
+                        log.info("Exact match found!")
+                        command=c
+                        # If a command was found, stop looking for others
+                        break
+                else: # Enter here if the "exact_command_keyword_match" flag is set to False
+                    if user_command.find(c.command_keyword) != -1:
+                        log.info("Sub-string match found!")
+                        command = c
+                        # If a command was found, stop looking for others
+                        break
             else:
                 log.debug(f"card_callback_keyword: {c.card_callback_keyword}")
                 if user_command == c.command_keyword or user_command == c.card_callback_keyword:
@@ -325,7 +337,7 @@ class WebexBot(WebexWebsocketClient):
             self.teams.messages.create(**reply)
             reply = "ok"
         # Support returning a list of Responses
-        elif reply and isinstance(reply, list):
+        elif reply and (isinstance(reply, list) or isinstance(reply, types.GeneratorType)):
             for response in reply:
                 # Make sure is a Response
                 if isinstance(response, Response):

webex_bot/websockets/webex_websocket_client.py

@@ -9,7 +9,7 @@ import backoff
 import certifi
 import requests
 import websockets
-from webexteamssdk import WebexTeamsAPI
+from webexpythonsdk import WebexAPI
 
 try:
     from websockets_proxy import Proxy, proxy_connect
@@ -45,7 +45,7 @@ class WebexWebsocketClient(object):
                  on_card_action=None,
                  proxies=None):
         self.access_token = access_token
-        self.teams = WebexTeamsAPI(access_token=access_token, proxies=proxies)
+        self.teams = WebexAPI(access_token=access_token, proxies=proxies)
         self.device_url = device_url
         self.device_info = None
         self.on_message = on_message

{webex_bot-0.5.1.dist-info → webex_bot-0.6.0.dist-info}/METADATA

@@ -1,33 +1,55 @@
-Metadata-Version: 2.1
-Name: webex-bot
-Version: 0.5.1
+Metadata-Version: 2.4
+Name: webex_bot
+Version: 0.6.0
 Summary: Python package for a Webex Bot based on websockets.
 Home-page: https://github.com/fbradyirl/webex_bot
 Author: Finbarr Brady
 Author-email: finbarr@somemail.com
 License: MIT license
 Keywords: webex_bot
-Platform: UNKNOWN
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Requires-Python: >=3.8
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: webexteamssdk ==1.6.1
+Requires-Dist: webexpythonsdk==2.0.4
 Requires-Dist: coloredlogs
-Requires-Dist: websockets ==11.0.3
+Requires-Dist: websockets==11.0.3
 Requires-Dist: backoff
 Provides-Extra: proxy
-Requires-Dist: websockets-proxy >=0.1.1 ; extra == 'proxy'
+Requires-Dist: websockets_proxy>=0.1.1; extra == "proxy"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Introduction
 
 [![Pypi](https://img.shields.io/pypi/v/webex_bot.svg)](https://pypi.python.org/pypi/webex_bot) [![Build Status](https://github.com/fbradyirl/webex_bot/workflows/Python%20package/badge.svg)](https://github.com/fbradyirl/webex_bot/actions)
 
+> [!IMPORTANT]
+> This repository is only sporadically maintained. Breaking API changes will be maintained on a best efforts basis.
+>
+> Collaborators are welcome, as are PRs for enhancements.
+>
+> Bug reports unrelated to API changes may not get the attention you want.
+
+
 By using this module, you can create a [Webex Teams][5] messaging bot quickly in just a couple of lines of code.
 
 This module does not require you to set up an ngrok tunnel to receive incoming messages when behind a firewall or
@@ -41,7 +63,7 @@ inside a LAN. This package instead uses a websocket to receive messages from the
 * Allows for single or multi-post responses. This is useful if you want to reply with a lot of data, but it won't all
   fit in a single response.
 * Restrict bot to certain users or domains.
-* Uses the [webexteamssdk][2] package to send back replies from the bot.
+* Uses the [webexpythonsdk][2] package to send back replies from the bot.
 
 ## 🚀 Getting started
 
@@ -53,7 +75,7 @@ You can find a sample project, using OpenAI/ChatGPT with this library here: http
 
 ----
 
-**Only Python 3.9 is tested at this time.**
+**Only Python 3.13 is tested at this time.**
 
 1. Install this module from pypi:
 
@@ -66,7 +88,7 @@ If you need optional proxy support, use this command instead:
 2. On the Webex Developer portal, create a new [bot token][3] and expose it as an environment variable.
 
 ```sh
-export WEBEX_TEAMS_ACCESS_TOKEN=<your bots token>
+export WEBEX_ACCESS_TOKEN=<your bots token>
 ```
 
 3. Run your script:
@@ -89,7 +111,7 @@ proxies = {
 }
 
 # Create a Bot Object
-bot = WebexBot(teams_bot_token=os.getenv("WEBEX_TEAMS_ACCESS_TOKEN"),
+bot = WebexBot(teams_bot_token=os.getenv("WEBEX_ACCESS_TOKEN"),
                approved_rooms=['06586d8d-6aad-4201-9a69-0bf9eeb5766e'],
                bot_name="My Teams Ops Bot",
                include_demo_commands=True,
@@ -107,9 +129,9 @@ where EchoCommand is defined as:
 ```python
 import logging
 
-from webexteamssdk.models.cards import Colors, TextBlock, FontWeight, FontSize, Column, AdaptiveCard, ColumnSet, \
+from webexpythonsdk.models.cards import Colors, TextBlock, FontWeight, FontSize, Column, AdaptiveCard, ColumnSet, \
     Text, Image, HorizontalAlignment
-from webexteamssdk.models.cards.actions import Submit
+from webexpythonsdk.models.cards.actions import Submit
 
 from webex_bot.formatting import quote_info
 from webex_bot.models.command import Command
@@ -201,7 +223,8 @@ and off you go!
 
 # Help
 
-* If you are a Cisco employee, you can join the [discussion space here][7].
+* If you are a Cisco employee, and find this useful, consider sending me a [Connected Recognition][8] (cec: `fibrady`) 🙂
+* Also, join the [discussion space here][7].
 * Alternatively, open an issue or PR with a question on usage.
 
 # History
@@ -382,9 +405,42 @@ and off you go!
 
 * Add Proxy Support. ([#56][pr56])
 
+### 0.5.2 (2024-Aug-21)
+
+* Introduce exact_command_keyword_match feature ([#59][pr59])
+
+### 0.6.0 (2025-Apr-24)
+
+* Migrate from "webexteamssdk" library to "webexpythonsdk" library ([#62][pr62])
+* Updated webexpythonsdk library version ([#69][pr69])
+* Added support for generators ([#71][pr71])
+
+#### Breaking changes for the existing webex_bot based applications:
+
+* Support is limited to only Python 3.10+ versions. webex_bot applications running on lower Python versions will have to
+  adapt to this change in Python version requirement.
+* Make the following code changes to your webex_bot application to adapt to ```webex_bot 0.6.0 version and upwards```.
+
+1. ***Mandatory step:*** Replace all imports from `webexteamssdk` to `webexpythonsdk`. For example:
+```
+from webexteamssdk.models.cards import TextBlock
+```
+to
+```
+from webexpythonsdk.models.cards import TextBlock\
+```
+2. ***This step is applicable only if you pass your Webex bot access token to webex_bot via environment variable:*** Change your Webex bot access token environment variable from `WEBEX_TEAMS_ACCESS_TOKEN` to `WEBEX_ACCESS_TOKEN`. Also, make the following code change in your webex_bot application:
+```
+bot = WebexBot(teams_bot_token=os.getenv("WEBEX_TEAMS_ACCESS_TOKEN")
+```
+to
+```
+bot = WebexBot(teams_bot_token=os.getenv("WEBEX_ACCESS_TOKEN")
+```
+
 [1]: https://github.com/aaugustin/websockets
 
-[2]: https://github.com/CiscoDevNet/webexteamssdk
+[2]: https://github.com/WebexCommunity/WebexPythonSDK
 
 [3]: https://developer.webex.com/docs/bots
 
@@ -396,6 +452,8 @@ and off you go!
 
 [7]: https://eurl.io/#TeBLqZjLs
 
+[8]: https://www.globoforce.net/microsites/t/awards/Redeem?client=cisco&setCAG=true
+
 [pr43]: https://github.com/fbradyirl/webex_bot/pull/43
 
 [pr46]: https://github.com/fbradyirl/webex_bot/pull/46
@@ -408,6 +466,14 @@ and off you go!
 
 [pr56]: https://github.com/fbradyirl/webex_bot/pull/56
 
+[pr59]: https://github.com/fbradyirl/webex_bot/pull/59
+
+[pr62]: https://github.com/fbradyirl/webex_bot/pull/62
+
+[pr69]: https://github.com/fbradyirl/webex_bot/pull/69
+
+[pr71]: https://github.com/fbradyirl/webex_bot/pull/71
+
 [i1]: https://github.com/fbradyirl/webex_bot/issues/1
 
 [i2]: https://github.com/fbradyirl/webex_bot/issues/2
@@ -417,5 +483,3 @@ and off you go!
 [i13]: https://github.com/fbradyirl/webex_bot/issues/13
 
 [i20]: https://github.com/fbradyirl/webex_bot/issues/20
-
-

webex_bot-0.6.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+webex_bot/__init__.py,sha256=S5gT3L7JqYWDSwjnLQa_VGARrFqlB4Q6IF_ElUCnWWs,95
+webex_bot/exceptions.py,sha256=qs9yVitfJtvxwBMC8uCvTDOxUQ_oZjWFf1dU8Oaue14,740
+webex_bot/formatting.py,sha256=jvPKym-z8CIJygpPVTVbt6vFXQo9_HQHpRDJB-nh-SI,382
+webex_bot/webex_bot.py,sha256=pLNmcAP7J9ZG9QnEDZLYZJa_y1qtO5vudhT0fAi2stA,21282
+webex_bot/cards/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+webex_bot/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+webex_bot/commands/echo.py,sha256=STY-MikBRjUteDK-g8G4GPB0V-Yi7siPN1DRMXrT-QU,3399
+webex_bot/commands/help.py,sha256=n7sbnJHepNSqUgZ0-8PW37kbGsaqvGIk2-jYy6I7ch4,3470
+webex_bot/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+webex_bot/models/command.py,sha256=MyThlDaEkGlj1fDE_i_wr79O3QboakimRme8yI744yo,5327
+webex_bot/models/response.py,sha256=d4k2ohR5SUVzvuQzcnm7jQQVTMB0gH9Kz9y09vkoAaU,2545
+webex_bot/websockets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+webex_bot/websockets/webex_websocket_client.py,sha256=kYepNP4gK0dddPndtK6ltCg52TYMhMtMHVKkxO15jTs,10618
+webex_bot-0.6.0.dist-info/licenses/LICENSE,sha256=93eGb10xmgkBP2Fh_n0E9YDXe0c0oz-FsnAimXG0S4Y,1072
+webex_bot-0.6.0.dist-info/METADATA,sha256=cOLj7txCMm0F0rwwtSmNb9Vf0T54sO6Jx3U6h--dPC0,14348
+webex_bot-0.6.0.dist-info/WHEEL,sha256=AeO2BvogYWm3eGaHCvhzmUYt8ia7KfURiHzO_1atlys,109
+webex_bot-0.6.0.dist-info/top_level.txt,sha256=q1Y0RtYYinR7oXSwL93cK59c2KN_CbMVca8MLWeF63M,10
+webex_bot-0.6.0.dist-info/RECORD,,

{webex_bot-0.5.1.dist-info → webex_bot-0.6.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (79.0.1)
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any

webex_bot-0.5.1.dist-info/RECORD

@@ -1,18 +0,0 @@
-webex_bot/__init__.py,sha256=fIrggpbtbmnosDI6vwtRg8leUTo8BeJZJZqojDOzZGM,95
-webex_bot/exceptions.py,sha256=qs9yVitfJtvxwBMC8uCvTDOxUQ_oZjWFf1dU8Oaue14,740
-webex_bot/formatting.py,sha256=jvPKym-z8CIJygpPVTVbt6vFXQo9_HQHpRDJB-nh-SI,382
-webex_bot/webex_bot.py,sha256=f4qJeNfl1x-dvFyAxcBrAWTT0HB-pAq0Kl3gfjrXYe0,20473
-webex_bot/cards/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-webex_bot/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-webex_bot/commands/echo.py,sha256=YmeRVh56pzsj0_lRHDvgyrv6YqQQdRiusG65dHTh9qU,3397
-webex_bot/commands/help.py,sha256=s4buQxnmHijkqWiYs8RZ_H-yzi3EhAffSozPCGNndD0,3468
-webex_bot/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-webex_bot/models/command.py,sha256=Rok661eZM2Mg465CZ4GgctWi1RD-BD5Bruq0FsJ8GDQ,5023
-webex_bot/models/response.py,sha256=1U0EQv8O5R3-demaumxMExn278DG4AeQHhXP_g4xndk,2544
-webex_bot/websockets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-webex_bot/websockets/webex_websocket_client.py,sha256=QUTQUWgnBYg3bSZ857m_vM49Ns9GWHWT69TYP4U6R9I,10627
-webex_bot-0.5.1.dist-info/LICENSE,sha256=93eGb10xmgkBP2Fh_n0E9YDXe0c0oz-FsnAimXG0S4Y,1072
-webex_bot-0.5.1.dist-info/METADATA,sha256=aSiwp8MqPv55j1njJOpHRCF_FnDiB077O-f_hzKqBhg,11991
-webex_bot-0.5.1.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
-webex_bot-0.5.1.dist-info/top_level.txt,sha256=q1Y0RtYYinR7oXSwL93cK59c2KN_CbMVca8MLWeF63M,10
-webex_bot-0.5.1.dist-info/RECORD,,