kbot-py-client 2.0.4__tar.gz → 2.0.8__tar.gz

{kbot_py_client-2.0.4 → kbot_py_client-2.0.8}/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2024 Konverso SAS
+MIT License
+
+Copyright (c) 2025 Konverso
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{kbot_py_client-2.0.4 → kbot_py_client-2.0.8}/PKG-INFO

@@ -1,19 +1,21 @@
 Metadata-Version: 2.1
 Name: kbot-py-client
-Version: 2.0.4
-Summary: Client for Konverso Kbot
-Home-page: https://www.konverso.ai
+Version: 2.0.8
+Summary: Client for Konverso Kbot.
+License: MIT
 Author: Konverso
 Author-email: contact@konverso.ai
-Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12,<4.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: requests (>=2.27.1)
+Project-URL: Homepage, https://www.konverso.ai/
+Project-URL: Source, https://github.com/konverso-ai/kbot-py-client
 Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests>=2.27.1
 
-# README #
+# kbot-py-client #
 This package contains utilities which you may use to easily interact with Konverso Kbot application. 
  
 In particular, you may:
@@ -30,13 +32,19 @@ You may contact us:
 * For any commercial inquiry: contact@konverso.ai
 * For support: https://konverso.atlassian.net/servicedesk/customer/portals
  
-### Installation ###
+## License
+This client code is open source such that you can freely view it, modify it, create your own version.
+We of course appreciate any contribution and sharing of enhancements made.
+
+# Installation #
 
 You may use pip3 to install the software on your Kbot instance: 
 
-First Navigate to your work-area and then invoke: 
+    pip3 install kbot-py-client
+
+Alternatively, you can invoke a more explicity pip installation request, with the URL path: 
 
-	pip3 install -e git+https://konverso@bitbucket.org/konversoai/kbot-py-client.git#egg=kbot-py-client
+	pip3 install -e git+https://github.com/konverso-ai/kbot-py-client.git#egg=kbot-py-client
 
 # Usage #
 
@@ -146,8 +154,30 @@ In this example, we create a conversation between the logged in user and the bot
     	else:
     	    print("Could not create conversation due to: ", r.text)
 	
-## Uploading one file to kbot
 
+## Command line chatbot
+The following sample is a complete example you may use to kick off a chat for a given user with the kbot chatbot.
+Here there is no user authentication, but impersonation instead, and user/lookup. This example is a good starting point if you are looking at implementing your own chat interface on top of Kbot.
+```
+# Create a session using an API key with strong privileges
+cli = Client("mytenant.konverso.ai", api_key="34exxxxxxxxxxxxxa7bfb6aeb")
+ 
+# Lookup create the user in kbot
+response = cli.post("user/lookup_create", data={
+    "user_name": user_email,
+    "account_name": user_email,
+    "account_type": "local",
+    "external_auth": "nice-in-connect",
+})
+response.raise_for_status()
+ 
+cli.impersonate(user_email, 'local', 'nice-in-connect') #, application_uuid="b0d91200-833f-466c-b5fd-1b0402cc3a36")
+ 
+# Start the client (loop… ends with Ctrl D)
+AsyncChatClient(cli)
+```
+
+## Uploading one file to kbot
 
 ### Prerequisites
 * A local file that you wish to send
@@ -186,7 +216,7 @@ In this example, we create a conversation between the logged in user and the bot
 
 ### Code sample
 In this example, we simply upload the content of a directory to a folder in the file manager.
-
+```
         from kbot_client import Client
         from kbot_client.folder_sync import FolderSync
 
@@ -195,3 +225,40 @@ In this example, we simply upload the content of a directory to a folder in the
         syncer = FolderSync(client)
         syncer.sync("/tmp/my_source_folder/", "1831f-XXXXXXXXXXXXXXXXXXXXXXX")
         print("Syncing is done :)")
+```
+
+## A command line chatbot
+We provide a sample command line chatbot, available in Sync or Async mode
+
+### Code sample
+In this example, we simply initialize a chatbot client after creating a relevant User and Impersonating to it. 
+This is a good example of implementation of a custom Client for the Kbot product.
+
+```
+# Create your client
+import json
+from kbot_client import Client
+from kbot_client.chat_client import AsyncChatClient, SyncChatClient
+
+cli = Client("mytenant.konverso.ai", api_key="mykey")
+
+external_auth = "cmd-line-chatbot"
+user_email = "a-user-name"
+assistant = "225d9647-0b41-473d-b097-ef4be363958a"
+
+# Create your target user
+response = cli.post("user/lookup_create", data={
+    "user_name": user_email,
+    "account_name": user_email,
+    "account_type": "local",
+    "external_auth": external_auth,
+})
+response.raise_for_status()
+
+# Impersonate accordingly
+cli.impersonate(user_email, 'local', external_auth)
+
+# Start the chat
+AsyncChatClient(cli, assistant=assistant, convert_html_to_text=True)
+
+```

kbot_py_client-2.0.4/kbot_py_client.egg-info/PKG-INFO → kbot_py_client-2.0.8/README.md

@@ -1,19 +1,4 @@
-Metadata-Version: 2.1
-Name: kbot-py-client
-Version: 2.0.4
-Summary: Client for Konverso Kbot
-Home-page: https://www.konverso.ai
-Author: Konverso
-Author-email: contact@konverso.ai
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests>=2.27.1
-
-# README #
+# kbot-py-client #
 This package contains utilities which you may use to easily interact with Konverso Kbot application. 
  
 In particular, you may:
@@ -30,13 +15,19 @@ You may contact us:
 * For any commercial inquiry: contact@konverso.ai
 * For support: https://konverso.atlassian.net/servicedesk/customer/portals
  
-### Installation ###
+## License
+This client code is open source such that you can freely view it, modify it, create your own version.
+We of course appreciate any contribution and sharing of enhancements made.
+
+# Installation #
 
 You may use pip3 to install the software on your Kbot instance: 
 
-First Navigate to your work-area and then invoke: 
+    pip3 install kbot-py-client
+
+Alternatively, you can invoke a more explicity pip installation request, with the URL path: 
 
-	pip3 install -e git+https://konverso@bitbucket.org/konversoai/kbot-py-client.git#egg=kbot-py-client
+	pip3 install -e git+https://github.com/konverso-ai/kbot-py-client.git#egg=kbot-py-client
 
 # Usage #
 
@@ -146,8 +137,30 @@ In this example, we create a conversation between the logged in user and the bot
     	else:
     	    print("Could not create conversation due to: ", r.text)
 	
-## Uploading one file to kbot
 
+## Command line chatbot
+The following sample is a complete example you may use to kick off a chat for a given user with the kbot chatbot.
+Here there is no user authentication, but impersonation instead, and user/lookup. This example is a good starting point if you are looking at implementing your own chat interface on top of Kbot.
+```
+# Create a session using an API key with strong privileges
+cli = Client("mytenant.konverso.ai", api_key="34exxxxxxxxxxxxxa7bfb6aeb")
+ 
+# Lookup create the user in kbot
+response = cli.post("user/lookup_create", data={
+    "user_name": user_email,
+    "account_name": user_email,
+    "account_type": "local",
+    "external_auth": "nice-in-connect",
+})
+response.raise_for_status()
+ 
+cli.impersonate(user_email, 'local', 'nice-in-connect') #, application_uuid="b0d91200-833f-466c-b5fd-1b0402cc3a36")
+ 
+# Start the client (loop… ends with Ctrl D)
+AsyncChatClient(cli)
+```
+
+## Uploading one file to kbot
 
 ### Prerequisites
 * A local file that you wish to send
@@ -186,7 +199,7 @@ In this example, we create a conversation between the logged in user and the bot
 
 ### Code sample
 In this example, we simply upload the content of a directory to a folder in the file manager.
-
+```
         from kbot_client import Client
         from kbot_client.folder_sync import FolderSync
 
@@ -195,3 +208,40 @@ In this example, we simply upload the content of a directory to a folder in the
         syncer = FolderSync(client)
         syncer.sync("/tmp/my_source_folder/", "1831f-XXXXXXXXXXXXXXXXXXXXXXX")
         print("Syncing is done :)")
+```
+
+## A command line chatbot
+We provide a sample command line chatbot, available in Sync or Async mode
+
+### Code sample
+In this example, we simply initialize a chatbot client after creating a relevant User and Impersonating to it. 
+This is a good example of implementation of a custom Client for the Kbot product.
+
+```
+# Create your client
+import json
+from kbot_client import Client
+from kbot_client.chat_client import AsyncChatClient, SyncChatClient
+
+cli = Client("mytenant.konverso.ai", api_key="mykey")
+
+external_auth = "cmd-line-chatbot"
+user_email = "a-user-name"
+assistant = "225d9647-0b41-473d-b097-ef4be363958a"
+
+# Create your target user
+response = cli.post("user/lookup_create", data={
+    "user_name": user_email,
+    "account_name": user_email,
+    "account_type": "local",
+    "external_auth": external_auth,
+})
+response.raise_for_status()
+
+# Impersonate accordingly
+cli.impersonate(user_email, 'local', external_auth)
+
+# Start the chat
+AsyncChatClient(cli, assistant=assistant, convert_html_to_text=True)
+
+```

{kbot_py_client-2.0.4 → kbot_py_client-2.0.8}/kbot_client/chat_client.py

@@ -1,13 +1,16 @@
+import uuid
 import time
 from abc import ABC, abstractmethod
 
 class ChatClient(ABC):
     def __init__(self, client,
-                 render_types=("text", "html"),
+                 render_types=("text", "html", "markdown"),
                  prompt="{sender}> {message}",
                  user_prompt = "User> ",
                  bye = "Bye, hope to see you again soon",
-                 exit_commands = ("stop", "exit")):
+                 assistant = None,
+                 exit_commands = ("stop", "exit"),
+                 convert_html_to_text=False):
 
         self._client = client
         self._render_types = render_types
@@ -15,10 +18,15 @@ class ChatClient(ABC):
         self._user_prompt = user_prompt
         self._bye = bye
         self._exit_commands = exit_commands
+        self._assistant = assistant
+        self._convert_html_to_text = convert_html_to_text
 
         # Create a new conversation
         #
-        response = self._client.post("conversation", data={"username": "bot"})
+        response = self._client.post("conversation",
+                data={
+                    "username": "bot",
+                    "assistant": assistant})
         response.raise_for_status()
 
         # Print the first welcome message
@@ -74,14 +82,21 @@ class ChatClient(ABC):
                         self._display_response(message_content)
 
         elif context == "response":
-            #print(messages_json)
+
+            stop = not messages_json.get("dialog_in_progress")
 
             for one_message in messages_json.get("messages"):
-                self._sender = one_message.get("sender").get("name")
+
                 message_type = one_message.get("type")
 
-                if message_type == "stop_topic":
-                    stop = True
+                if message_type == "typing":
+                    continue
+
+                self._sender = one_message.get("sender").get("name")
+
+                # Deprecated. Applicable only for old kbot versions (before 2024.01)
+                #if message_type == "stop_topic":
+                #    stop = True
 
                 if one_message.get("type") != "message":
                     continue
@@ -99,7 +114,33 @@ class ChatClient(ABC):
                       "value": "Hello John",
                        ...
         """
-        print(self._prompt.format(sender=self._sender, message=message.get('value')))
+
+        # Potentially need to convert the message: 
+        message_format = message.get('format')
+
+        if message_format == "text":
+            message_value = message.get('value')
+
+        elif message_format == "html":
+            if self._convert_html_to_text:
+                try:
+                    from bs4 import BeautifulSoup
+                    message_value = BeautifulSoup(message.get('value'), 'html.parser').get_text()
+                except:
+                    print("ERROR: HTML to Text conversion requested, but beautifull soup is not installed. Use: ")
+                    print("pip3 install BeautifulSoup4")
+                    message_value = message.get('value')
+            else:
+                message_value = message.get('value')
+        elif message_format == "markdown":
+            message_value = message.get('value')
+
+        else:
+            print("Unsupported format:", message.get('format'))
+            message_value = message.get('value')
+
+        # finally display the result to the user
+        print(self._prompt.format(sender=self._sender, message=message_value))
 
     def _start_question_answer_loop(self, conversation_id):
 
@@ -130,10 +171,11 @@ class ChatClient(ABC):
         # Send the user question to Kbot.
         #
         data = {
-            "conversation_id": conversation_id,
-            "type":"message",
-            "message": question,
-            "fromUser": True,
+            'conversation_id': conversation_id,
+            'type': 'message',
+            'message': question,
+            'message_id': str(uuid.uuid4()),
+            'assistant': self._assistant
         }
 
         response = self._client.post(f"conversation/{conversation_id}/message", data=data)

kbot_py_client-2.0.8/pyproject.toml

@@ -0,0 +1,119 @@
+[tool.poetry]
+name = "kbot-py-client"
+version = "2.0.8"
+description = "Client for Konverso Kbot."
+authors = ["Konverso <contact@konverso.ai>"]
+classifiers=[
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+readme = "README.md"
+license = "MIT"
+packages = [
+    { include = "kbot_client" },
+]
+
+[tool.poetry.urls]
+Homepage = "https://www.konverso.ai/"
+Source = "https://github.com/konverso-ai/kbot-py-client"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+requests = ">=2.27.1"
+
+[tool.poetry.group.dev.dependencies]
+ruff = "0.4.4"
+pytest = "8.2.1"
+pytest-env = "1.1.3"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.ruff]
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+# Assume Python 3.10
+target-version = "py310"
+
+[tool.pytest]
+testpaths = "tests"
+addopts = "-vv"
+python_files = "test_*.py"
+
+# [tool.pytest.ini_options]
+# asyncio_mode = "auto"
+
+[tool.ruff.lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
+# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
+# McCabe complexity (`C901`) by default.
+select = ["E4", "E7", "E9", "F"]
+ignore = ["F401", "E722"]
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+# dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"

kbot_py_client-2.0.4/.gitignore

@@ -1,50 +0,0 @@
-# These are some examples of commonly ignored file patterns.
-# You should customize this list as applicable to your project.
-# Learn more about .gitignore:
-#     https://www.atlassian.com/git/tutorials/saving-changes/gitignore
-
-# Node artifact files
-node_modules/
-dist/
-
-# Compiled Java class files
-*.class
-
-# Compiled Python bytecode
-*.py[cod]
-
-# Log files
-*.log
-
-# Package files
-*.jar
-
-# Maven
-target/
-dist/
-
-# JetBrains IDE
-.idea/
-
-# Unit test reports
-TEST*.xml
-
-# Generated by MacOS
-.DS_Store
-
-# Generated by Windows
-Thumbs.db
-
-# Applications
-*.app
-*.exe
-*.war
-
-# Large media files
-*.mp4
-*.tiff
-*.avi
-*.flv
-*.mov
-*.wmv
-

kbot_py_client-2.0.4/README.md

@@ -1,182 +0,0 @@
-# README #
-This package contains utilities which you may use to easily interact with Konverso Kbot application. 
- 
-In particular, you may:
-
-* Invoke some of the APIs to view / update / create Kbot configuration objects such as Intents, Message, etc.
-* Collect metrics showing how the bot is performing.
-* Create a Conversation and interact with it, sending message and getting responses
-
-# See also #
-
-## Access Konverso Support
-You may contact us: 
-
-* For any commercial inquiry: contact@konverso.ai
-* For support: https://konverso.atlassian.net/servicedesk/customer/portals
- 
-### Installation ###
-
-You may use pip3 to install the software on your Kbot instance: 
-
-First Navigate to your work-area and then invoke: 
-
-	pip3 install -e git+https://konverso@bitbucket.org/konversoai/kbot-py-client.git#egg=kbot-py-client
-
-# Usage #
-
-You would typically first need to login and then invoke some of the API wrapped methods.
-
-## Login ##
-
-	import json
-	
-	from kbot_client import Client
-
-### Using user / password ###
-
-	cli = Client("mybot.konverso.ai")
-	cli.login("myuser", "mysecretpassword")
-
-The API Key may be created for a given user, with relevant permissions, from the Configuration / Users & Roles / Users / Accounts panel. Create an account of type "Local"
-
-### Using and api key ###
-
-	cli = Client("mybot.konverso.ai", api_key="xxxxxxxxxxxxxxxxxxx")
-
-The API Key may be created for a given user, with relevant permissions, from the Configuration / Users & Roles / Users / Accounts panel. Create an account of type "API Key"
-
-## Collect metrics
-Once authenticated, you can for example retrieve useful usage metrics, these can be used by a Monitoring application or for some business intelligence rendering: 
-
-	metrics = cli.metric().json()
-	print("Collected metrics:")
-	print(json.dumps(metrics, indent=4))
-
-## Invoke a Workflow and retrieve result
-This is the most powerful mechanism, that let you invoke any business and processing logic in a workflow, leveraging all the capabilities of our platform, and retrieve the result
-
-    r = client.request("post",
-        "workflow/execute",
-        {
-            "name": "Test API Workflow",
-            "keywords": {
-                "var1": "abc"
-            },
-            "result": ["response"]
-        }
-    )
-    print(r.json())
-
-## Invoke a search
-You may invoke a search on any of the configured Search Contexts
-Note the search context UUID passed in the URL, which you may retrieve from our Search Context portal. 
-
-    r = client.request("post", "searchcontext/234923-235-sjdhfs-kdjf/search",
-        {
-            "sentence": "how to create a classifier",
-            "num_results": 20,
-            #"variables": {'kbs': {'value': ['Confluence_Security_KSEC']}}
-        }
-    )
-
-
-## Retrieve object details
-You may retrieve list of defined objects. Note that only objects visibled to the logged in users will be returned.
-
-Here is a sample code that simply checks for a few objects existance: 
-
-## Get list of objects and check if object with name is present in response
-	for unit, name in (('intention' ,'Create ticket'),
-	                   ('knowledge_base', 'faq'),
-	                   ('workflow', 'Transfer to Agent')):
-    	print(f"Get list of '{unit}'")
-    	objs = cli.unit(unit)
-    	if objs:
-        	# Create dict with
-        	# - key : object name
-        	# - value : object json data
-        	data = {obj['name']: obj for obj in objs}
-        	if name in data:
-            	print(f"'{name}' is present")
-        	else:
-            	print(f"'{name}' is not present")
-    	else:
-        	print("Get no data")
-		
-## Conversation test
-In this example, we create a conversation between the logged in user and the bot and then sends a sentence, and check if we get some expected text in the response. This could for example be the basis of automated testing of the bot
-
-    	r = cli.conversation(username='bot')
-    	if r.status_code == 201:
-    	    cid = r.json().get('id')
-    	    print("Created conversation with id '%s'" %(cid,))
-
-    	    response = cli.message(cid, 'hello')
-
-    	    # Process bot response
-    	    if response:
-    	        for resp in response:
-    	            for message in resp.get('message', []):
-    	                responses.append(message.get('value', '')) # dict {message type: message value}
-    	                resp_message = '\n'.join(responses)
-                        print("Received response: ", resp_message)
-                        if 'I am kbot' in resp_message:
-                            print("Excepted response found")
-                            break
-                    else:
-                        print("Did not receive the expected response")
-    	    else:
-    	        print("Did not receive any response")
-    	else:
-    	    print("Could not create conversation due to: ", r.text)
-	
-## Uploading one file to kbot
-
-
-### Prerequisites
-* A local file that you wish to send
-* The UUID of the folder that will receive the files you want to upload
-
-### Code sample
-```
-        current_top_folder = "uuid-of-a-folder"
-        filepath = "/tmp/test.pdf"
-        filename = os.path.basename(filepath)
-        
-        # Upload to remote filemanager
-        with open(filepath, "rb") as fd:
-            files = {
-                        "upload_files": fd
-                    }
-            params= {
-                        "override": False
-                    }
-            data = {
-                        "folder": current_top_folder,
-                        "name": file_name,
-                    }
-            response = self.client.post_file("attachment",
-                                                     data=data,
-                                                     params=params,
-                                                     files=files)
-```
-
-## Uploading a batch of files to the file manager
-
-### Prerequisites
-
-* An API key
-* The UUID of the folder that will receive the files you want to upload
-
-### Code sample
-In this example, we simply upload the content of a directory to a folder in the file manager.
-
-        from kbot_client import Client
-        from kbot_client.folder_sync import FolderSync
-
-        client = Client("mybot.konverso.ai", api_key="17ebXXXXXXXXXXXXXXXXXXXXX")
-
-        syncer = FolderSync(client)
-        syncer.sync("/tmp/my_source_folder/", "1831f-XXXXXXXXXXXXXXXXXXXXXXX")
-        print("Syncing is done :)")

kbot_py_client-2.0.4/kbot_client/client.recording.py

@@ -1,316 +0,0 @@
-"""Dialog tester"""
-import json
-import time
-
-import requests
-
-
-class Client:
-    """Base representation of Kbot instance"""
-
-    def __init__(self, server, port=443, proto='https', api_key=None, verify=True):
-        """
-
-
-        Arguments:
-            - server: an Host or Ip Address
-            - port : default to 443
-            - proto: HTTP or HTTPS
-            - api_key: A Kbot valid API Key. If provided all requests will be sent with this API Key
-                       and it is not required to invoke the login method
-        """
-
-        self.host = server
-        self.verify = verify
-
-        if str(port).endswith('443'):
-            proto = 'https'
-        else:
-            proto = 'http'
-
-        if port in (80, 443):
-            self.url = "%s://%s" % (proto, server)
-        else:
-            self.url = "%s://%s:%s" % (proto, server, port)
-
-        self._login = False
-        self._headers = {}
-
-        self._recording_fd = None
-
-        if api_key:
-            self._headers = {
-                'Content-Type': 'application/json; charset=utf-8',
-                'X-API-KEY': api_key
-            }
-            self.schema()
-
-        # Variable populated by the login:
-        self._user_id = None
-
-        # Variable populated by the conversation
-        self._cid = None
-
-        # The refresh token may be used in case
-        # the access token as expired
-        self.__refresh_token = None
-
-    @property
-    def admin_url(self):
-        """Returns the URL of the Kbot Administration view"""
-        return "%s/admin" % self.url
-
-    @property
-    def chat_url(self):
-        """Returns the default URL of the Kbot chat view"""
-        return "%s" % self.url
-
-    @property
-    def avatar_url(self):
-        return "%s/images/kbot_avatar.png" % self.url
-
-    def record_start(self, file_descriptor):
-        self._recording_fd = file_descriptor
-        self._recording_fd.write("import requests\n\n")
-
-    def record_stop(self):
-        self._recording_fd = None
-
-    def login(self, username, password=None, timeout=5):
-        """Login to local channel"""
-        data = {}
-        data['username'] = username
-        data['usertype'] = 'local'
-        if password is not None:
-            data['password'] = password
-        else:
-            print("WARNING!!! Password is not set!!! Trying to use username...")
-            data['password'] = username
-
-        headers = {}
-        headers['Content-Type'] = 'application/json; charset=utf-8'
-
-        url = self.url + '/api/login'
-        r = requests.post(url, headers=headers, data=json.dumps(data), timeout=timeout, verify=self.verify)
-
-        r.raise_for_status()
-
-        self.__reset_headers(r.json())
-        self.schema()
-
-    def impersonate(self, username, usertype='local', external_auth='', application_uuid='', timeout=5):
-        """Impersonate the given user"""
-
-        r = self.request("post", "user/impersonate", data={
-            "username": username,
-            "im_type": usertype,
-            "external_auth": external_auth,
-            "application_uuid": application_uuid})
-
-        r.raise_for_status()
-
-        self.__reset_headers(r.json())
-        # After we impersonnate, we need to remove the original API KEY
-        if "X-API-KEY" in self._headers:
-            del self._headers["X-API-KEY"]
-
-        self.schema()
-
-    def schema(self):
-        """Retrieve the public schema of kbot and builds python method for each of the defined end points"""
-        r = self.get('schema')
-        r.raise_for_status()
-
-        j = r.json()
-        for epoint in j.get('endpoints', []):
-            if epoint['name'] != 'schema':
-                self.__add_method(epoint['method'], epoint['name'], epoint['path'], epoint['params'], epoint['data'], epoint.get('description', ''))
-
-    def __reset_headers(self, js):
-        """
-            Called when a login or impersonate end point is called.  Then expecting to get a json with:
-                - access_token
-                - refresh_token
-            Or in the case of a refresh call. Then we only get a json with:
-                - access_token
-
-            The header content is ajusted with the token information from the json
-        """
-        if not self._headers:
-            self._headers = {}
-            self._headers['Content-Type'] = 'application/json; charset=utf-8'
-
-        if js.get('access_token'):
-            self._headers['Authorization'] = js['access_token']
-
-        # The refresh token will be used by the refresh_token method later if the access token expires
-        if js.get('refresh_token'):
-            self.__refresh_token = js['refresh_token']
-
-        self._login = True
-        if js.get("user_id"):
-            self._user_id = js['user_id']
-
-    def __add_method(self, method: str, name: str, path: str, params: list, data: list, description: str):
-        """Method to add a new dynamic method, based on the schema. This provides "python method" wrapper
-           on top of the kbot APIs
-        """
-        def endpoint(*args, **kwargs):
-            """Invoke request to endpoint"""
-            rargs = {}
-            for aname, values in (('params', params), ('data', data)):
-                rargs[aname] = {}
-                for value in values:
-                    if value['mandatory'] and value['name'] not in kwargs:
-                        raise RuntimeError("Missed attribute '%s' in '%s'" % (value['name'], aname))
-                    # pylint: disable=eval-used
-                    if value['name'] in kwargs:
-                        if not isinstance(kwargs[value['name']], eval(value['type'])):
-                            raise RuntimeError("Invalid type of attribute '%s'" % (value['name']))
-                        v = kwargs[value['name']]
-                    elif value['name'] not in kwargs and value['default'] is not None:
-                        v = value['default']
-                    else:
-                        continue
-                    rargs[aname][value['name']] = v
-            return self.__request(method, uri=path % args, **rargs)
-        endpoint.__doc__ = description
-        endpoint.__name__ = name
-        setattr(self, name, endpoint)
-
-    def __refresh(self):
-        r = requests.post(self.url + "/api/refresh",
-                          data=json.dumps({"refresh_token": self.__refresh_token}),
-                          headers=self._headers)
-        r.raise_for_status()
-        self.__reset_headers(r.json())
-
-    def __request(self, method: str, uri : str = None, data: dict = None, params: dict = None, files: dict = None, attempt=0):
-        dump_data = json.dumps(data or {})
-
-        if files:
-            headers = self._headers.copy()
-            del headers['Content-Type']
-            headers['Accept'] = "*/*"
-        else:
-            headers = self._headers
-
-        r = requests.request(method.upper(), self.url + '/api/%s/' % (uri), params=params, data=dump_data, headers=headers, verify=self.verify)
-
-        # The recording if configured to do so
-        if self._recording_fd:
-            self._recording_fd.write("\n##  {uri}".format(uri='/api/%s/' % (uri)))
-            self._recording_fd.write("\nheaders = {headers}".format(headers=json.dumps(headers)))
-            self._recording_fd.write("\nparams = {params}".format(params=json.dumps(params)))
-            self._recording_fd.write("\ndata = {data}".format(data=json.dumps(data)))
-            self._recording_fd.write("\nr = requests.request({method}, {url}, params=params, data=data)".format(
-                method=method.upper(), url=self.url + '/api/%s/' % (uri)))
-            self._recording_fd.write("\nr.raise_for_status()")
-
-        if r.status_code == 401:
-            # Refresh the token
-            try:
-                self.__refresh()
-            except Exception as e:
-
-                # We try 3 times at the most
-                if attempt == 3:
-                    raise e
-
-                time.sleep(3)
-
-            # Re-invoke the request
-            r = self.__request(method, uri=uri, data=data, params=params, attempt=attempt+1)
-
-        return r
-
-    def request(self, method: str, uri: str, data: dict = None, params: dict = None):
-        return self.__request(method, uri=uri, data=data, params=params)
-
-    def unit(self, name: str, params=None) -> dict:
-        r = self.get(name, params)
-        if r:
-            return r.json()
-        return None
-
-    def message(self, cid: int, message: str, timeout: int=60) -> list:
-        response = []
-
-        data = {'type': 'message', 'message': message}
-        r = self.request("post", f'conversation/{cid}/message', data)
-
-        r.raise_for_status()
-
-        curtime = time.time()
-        while timeout > 0:
-            r = self.get(f'conversation/{cid}')
-
-            r.raise_for_status()
-
-            j = r.json()
-            for resp in j:
-                if resp['type'] == 'message':
-                    # It's possible that bot will send several message to one input
-                    response.append(resp)
-                elif resp['type'] in ('stop_topic', 'wait_user_input'):
-                    # Bot stop to process
-                    # - stop_topic : bot stop to process message and ready for new topic
-                    # - wait_user_input : bot asked the question and wait for user answer
-                    timeout = 0
-            timeout = timeout + curtime - time.time()
-        return response
-
-    def logout(self):
-        """Logout from local channel"""
-        if self._login:
-
-            # If we have an open conversation, close it.
-            # if self._cid:
-            # What for?
-            #     self._process('logout', 1)
-
-            # Logout from the APIs
-            requests.post(self.url + '/api/logout', headers=self._headers, verify=self.verify)
-
-    #
-    # In addition to the Generated and built in API methods, we have the classic base REST methods
-    #
-    def get(self, unit, params=None):
-        return self.__request("get", unit, params=params)
-
-    def put(self, unit, data=None):
-        return self.__request("put", unit, data=data)
-
-    def post(self, unit, data=None):
-        return self.__request("post", unit, data=data)
-
-    def delete(self, unit, params=None):
-        return self.__request("delete", unit, params=params)
-
-    def post_file(self, unit, data, params=None, files=None):
-        """Attach the given files.
-           Sample parameter values:
-               unit = "attachment"
-               files = {
-                   "upload_files": (f, fd, "application/pdf")
-               }
-               params= {
-                   "override": False
-               }
-               data = {
-                   "folder": current_top_folder,
-                   "name": f,
-               }
-        """
-        return self.__request("post", unit, params=params, data=data, files=files)
-
-class UpKbotClient(Client):
-    """Represents a currently reachable Kbot instance"""
-
-
-class DownKbotClient(Client):
-    """Represents a currently not reachable Kbot instance"""
-
-    def __init__(self, server, port=443, proto='http', error=''):
-        super().__init__(server, port=port, proto=proto)
-        self.error = error

kbot_py_client-2.0.4/kbot_py_client.egg-info/SOURCES.txt

@@ -1,16 +0,0 @@
-.gitignore
-LICENSE
-README.md
-setup.py
-kbot_client/__init__.py
-kbot_client/chat_client.py
-kbot_client/client.py
-kbot_client/client.recording.py
-kbot_client/client_group.py
-kbot_client/folder_sync.py
-kbot_client/test.py
-kbot_py_client.egg-info/PKG-INFO
-kbot_py_client.egg-info/SOURCES.txt
-kbot_py_client.egg-info/dependency_links.txt
-kbot_py_client.egg-info/requires.txt
-kbot_py_client.egg-info/top_level.txt

kbot_py_client-2.0.4/kbot_py_client.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

kbot_py_client-2.0.4/kbot_py_client.egg-info/requires.txt

@@ -1 +0,0 @@
-requests>=2.27.1

kbot_py_client-2.0.4/kbot_py_client.egg-info/top_level.txt

@@ -1 +0,0 @@
-kbot_client

kbot_py_client-2.0.4/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

kbot_py_client-2.0.4/setup.py

@@ -1,23 +0,0 @@
-import setuptools
-
-with open("README.md", mode="r", encoding="utf-8") as fh:
-    long_description = fh.read()
-
-setuptools.setup(
-    name="kbot-py-client",
-    version="2.0.4",
-    author="Konverso",
-    author_email="contact@konverso.ai",
-    description="Client for Konverso Kbot",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    url="https://www.konverso.ai",
-    packages=setuptools.find_packages(),
-    install_requires=["requests>=2.27.1"],
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
-    ],
-    python_requires='>=3.6',
-)

{kbot_py_client-2.0.4 → kbot_py_client-2.0.8}/kbot_client/client.py

@@ -36,6 +36,10 @@ class Client:
         self._login = False
         self._headers = {}
 
+        # The refresh token may be used in case
+        # the access token as expired
+        self.__refresh_token = None
+
         if api_key:
             self._headers = {
                 'Content-Type': 'application/json; charset=utf-8',
@@ -49,10 +53,6 @@ class Client:
         # Variable populated by the conversation
         self._cid = None
 
-        # The refresh token may be used in case
-        # the access token as expired
-        self.__refresh_token = None
-
     @property
     def admin_url(self):
         """Returns the URL of the Kbot Administration view"""