symphony_bdk_python 2.11.0b0__tar.gz → 3.0.0b0__tar.gz

symphony_bdk_python-3.0.0b0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: symphony_bdk_python
+Version: 3.0.0b0
+Summary: Symphony Bot Development Kit for Python
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Author: Symphony Platform Solutions
+Author-email: symphony@finos.org
+Requires-Python: >=3.9, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*, !=3.8.*
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: PyJWT (>=2.10.0,<3.0.0)
+Requires-Dist: aiohttp (>=3.12.14,<4.0.0)
+Requires-Dist: aiohttp-retry (>=2.9.1,<3.0.0)
+Requires-Dist: cryptography (>=44.0.1,<45.0.0)
+Requires-Dist: defusedxml (>=0.7.1,<0.8.0)
+Requires-Dist: docutils (==0.16)
+Requires-Dist: nulltype (>=2.3.1,<3.0.0)
+Requires-Dist: pydantic (>=2.11.7,<3.0.0)
+Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: tenacity (>=8.0.1,<9.0.0)
+Requires-Dist: urllib3 (>=2.5.0,<3)
+Project-URL: Documentation, https://symphony-bdk-python.finos.org/
+Project-URL: Repository, https://github.com/finos/symphony-bdk-python
+Description-Content-Type: text/markdown
+
+[![FINOS - Active](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-active.svg)](https://community.finos.org/docs/governance/Software-Projects/stages/active)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/downloads/)
+[![Pypi](https://img.shields.io/pypi/v/symphony-bdk-python)](https://pypi.org/project/symphony-bdk-python/)
+![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/finos/symphony-bdk-python/build/main)
+
+# Symphony BDK for Python
+
+This is the Symphony BDK for Python to help develop bots and interact with the [Symphony REST APIs](https://rest-api.symphony.com).
+
+## Project Overview
+
+Symphony BDK for Python provides tools for building bots and integrating with Symphony APIs. This document outlines its usage, installation, and contribution guidelines.
+
+## Prerequisites
+
+- Python 3.9 or higher
+- [Poetry](https://python-poetry.org/docs/#installation)
+
+## Installation Steps
+
+### Option 1: Build from Source
+- Install dependencies: `poetry install`
+- Build the package: `poetry build`
+- Run tests: `poetry run pytest`
+- Perform a lint scan locally: `poetry run ruff check .`
+- Format code locally: `poetry run ruff format .`
+- Generate documentation locally: `cd docsrc && make html`
+
+### Setting Up Git Hooks
+This project uses `pre-commit` with `ruff` to automatically format and lint code. This is the recommended setup for contributors to ensure code style consistency.
+
+1. **Install development dependencies** (this will also install `pre--commit` and `ruff`):
+   ```bash
+   poetry install
+   ```
+2. **Install the git hooks**:
+   ```bash
+   poetry run pre-commit install
+   ```
+Now, `ruff` will automatically run on every commit, formatting your code and checking for linting errors.
+
+### Verification
+Verify the successful installation by running any of the following commands:
+```
+poetry --version
+```
+
+## External Documents
+
+Refer to the following for additional guidance:
+- [Reference Documentation](https://symphony-bdk-python.finos.org/)
+- [Getting Started Guide](https://symphony-bdk-python.finos.org/markdown/getting_started.html)
+
+## Roadmap
+
+The next milestone is the [2.5.x](https://github.com/finos/symphony-bdk-python/milestone/6), focused on delivering improvements and bug fixes.
+
+## Contributing
+
+To contribute:
+1. Fork the repository.
+2. Create a feature branch: `git checkout -b feature/fooBar`
+3. Read the [Contribution Guidelines](CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
+4. Commit changes: `git commit -am 'Add some fooBar'`
+5. Push changes: `git push origin feature/fooBar`
+6. Open a Pull Request.
+
+_NOTE:_ Ensure you have an active Individual Contributor License Agreement (ICLA) or Corporate Contribution License Agreement (CCLA) with FINOS.
+
+For further inquiries, email [help@finos.org](mailto:help@finos.org).
+
+### Updating Generated Code
+
+Python BDK uses [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator/) to generate code. 
+To update the generated code, follow these steps:
+
+1. Download desired version of openapi generator.
+     ```bash
+     cd api_client_generation
+     curl -L https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.14.0/openapi-generator-cli-7.14.0.jar      -o openapi-generator-cli.jar
+     ```
+2. Adjust the commit for which the code is generated(inside generate.sh script)
+3. Execute the generation script: 
+   ```bash
+   ./generate.sh
+   ```
+4. Commit and push the newly generated code along with the updated JAR file.
+
+Note: There are a few files that are not replaced(EX. api_client.py), those files require some modifications after code is generated.
+
+
+### OLD Updating Generated Code (Deprecated)
+
+Python BDK uses [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator/) to generate code. 
+To update the generated code, follow these steps:
+
+1. Checkout the latest branch of the fork (e.g., [sym-python-5.5.0](https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0)).
+2. Update the fork source code, review, and merge it.
+3. Generate the JAR file in `openapi-generatormodules/openapi-generator-cli/target/openapi-generator-cli.jar`:
+   - Use Maven: 
+     ```bash
+     mvn clean install -Dmaven.test.skip=true && mvn clean package -Dmaven.test.skip=true
+     ```
+   - Alternatively, use IntelliJ's build button to build the project and generate the JAR file.
+4. Copy the JAR file to the Python BDK repository: `symphony-api-client-python/api_client_generation/openapi-generator-cli.jar`.
+5. Execute the generation script: 
+   ```bash
+   ./generate.sh
+   ```
+6. Commit and push the newly generated code along with the updated JAR file.
+
+
+## License
+
+Copyright 2021 Symphony LLC
+
+Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0).
+

symphony_bdk_python-3.0.0b0/README.md

@@ -0,0 +1,120 @@
+[![FINOS - Active](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-active.svg)](https://community.finos.org/docs/governance/Software-Projects/stages/active)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/downloads/)
+[![Pypi](https://img.shields.io/pypi/v/symphony-bdk-python)](https://pypi.org/project/symphony-bdk-python/)
+![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/finos/symphony-bdk-python/build/main)
+
+# Symphony BDK for Python
+
+This is the Symphony BDK for Python to help develop bots and interact with the [Symphony REST APIs](https://rest-api.symphony.com).
+
+## Project Overview
+
+Symphony BDK for Python provides tools for building bots and integrating with Symphony APIs. This document outlines its usage, installation, and contribution guidelines.
+
+## Prerequisites
+
+- Python 3.9 or higher
+- [Poetry](https://python-poetry.org/docs/#installation)
+
+## Installation Steps
+
+### Option 1: Build from Source
+- Install dependencies: `poetry install`
+- Build the package: `poetry build`
+- Run tests: `poetry run pytest`
+- Perform a lint scan locally: `poetry run ruff check .`
+- Format code locally: `poetry run ruff format .`
+- Generate documentation locally: `cd docsrc && make html`
+
+### Setting Up Git Hooks
+This project uses `pre-commit` with `ruff` to automatically format and lint code. This is the recommended setup for contributors to ensure code style consistency.
+
+1. **Install development dependencies** (this will also install `pre--commit` and `ruff`):
+   ```bash
+   poetry install
+   ```
+2. **Install the git hooks**:
+   ```bash
+   poetry run pre-commit install
+   ```
+Now, `ruff` will automatically run on every commit, formatting your code and checking for linting errors.
+
+### Verification
+Verify the successful installation by running any of the following commands:
+```
+poetry --version
+```
+
+## External Documents
+
+Refer to the following for additional guidance:
+- [Reference Documentation](https://symphony-bdk-python.finos.org/)
+- [Getting Started Guide](https://symphony-bdk-python.finos.org/markdown/getting_started.html)
+
+## Roadmap
+
+The next milestone is the [2.5.x](https://github.com/finos/symphony-bdk-python/milestone/6), focused on delivering improvements and bug fixes.
+
+## Contributing
+
+To contribute:
+1. Fork the repository.
+2. Create a feature branch: `git checkout -b feature/fooBar`
+3. Read the [Contribution Guidelines](CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
+4. Commit changes: `git commit -am 'Add some fooBar'`
+5. Push changes: `git push origin feature/fooBar`
+6. Open a Pull Request.
+
+_NOTE:_ Ensure you have an active Individual Contributor License Agreement (ICLA) or Corporate Contribution License Agreement (CCLA) with FINOS.
+
+For further inquiries, email [help@finos.org](mailto:help@finos.org).
+
+### Updating Generated Code
+
+Python BDK uses [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator/) to generate code. 
+To update the generated code, follow these steps:
+
+1. Download desired version of openapi generator.
+     ```bash
+     cd api_client_generation
+     curl -L https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.14.0/openapi-generator-cli-7.14.0.jar      -o openapi-generator-cli.jar
+     ```
+2. Adjust the commit for which the code is generated(inside generate.sh script)
+3. Execute the generation script: 
+   ```bash
+   ./generate.sh
+   ```
+4. Commit and push the newly generated code along with the updated JAR file.
+
+Note: There are a few files that are not replaced(EX. api_client.py), those files require some modifications after code is generated.
+
+
+### OLD Updating Generated Code (Deprecated)
+
+Python BDK uses [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator/) to generate code. 
+To update the generated code, follow these steps:
+
+1. Checkout the latest branch of the fork (e.g., [sym-python-5.5.0](https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0)).
+2. Update the fork source code, review, and merge it.
+3. Generate the JAR file in `openapi-generatormodules/openapi-generator-cli/target/openapi-generator-cli.jar`:
+   - Use Maven: 
+     ```bash
+     mvn clean install -Dmaven.test.skip=true && mvn clean package -Dmaven.test.skip=true
+     ```
+   - Alternatively, use IntelliJ's build button to build the project and generate the JAR file.
+4. Copy the JAR file to the Python BDK repository: `symphony-api-client-python/api_client_generation/openapi-generator-cli.jar`.
+5. Execute the generation script: 
+   ```bash
+   ./generate.sh
+   ```
+6. Commit and push the newly generated code along with the updated JAR file.
+
+
+## License
+
+Copyright 2021 Symphony LLC
+
+Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0).

symphony_bdk_python-3.0.0b0/pyproject.toml

@@ -0,0 +1,94 @@
+[tool.poetry]
+name = "symphony_bdk_python"
+version = "3.0.0-beta"
+license = "Apache-2.0"
+description = "Symphony Bot Development Kit for Python"
+readme = "README.md"
+authors = ["Symphony Platform Solutions <symphony@finos.org>"]
+repository = "https://github.com/finos/symphony-bdk-python"
+documentation = "https://symphony-bdk-python.finos.org/"
+packages = [
+    { include = "symphony" }
+]
+
+[tool.poetry.dependencies]
+python = ">3.9.0,<3.9.1 || >3.9.1,<4.0"
+nulltype = "^2.3.1"
+python-dateutil = "^2.8.2"
+urllib3 = ">=2.5.0,<3"
+aiohttp = "^3.12.14"
+pyyaml = "^6.0"
+PyJWT = "^2.10.0"
+cryptography = "^44.0.1"
+tenacity = "^8.0.1"
+defusedxml = "^0.7.1"
+docutils = "0.16"
+pydantic = "^2.11.7"
+aiohttp-retry = "^2.9.1"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.3"
+pytest-cov = "^5.0.0"
+pytest-asyncio = "^0.24.0"
+Sphinx = "^4.4.0"
+jinja2 = "^3.1.6"
+recommonmark = "^0.7.1"
+furo = "^2022.3.4"
+hazelcast-python-client = "^5.0.1"
+safety = "^2.3.5"
+setuptools = "^79.0.0"
+liccheck = "^0.9.2"
+coverage = {version = "^6.0b1", extras = ["toml"]}
+ruff = "^0.12.8"
+pre-commit = "^4.3.0"
+
+[tool.poetry.requires-plugins]
+poetry-plugin-export = ">=1.8"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+addopts = "--junitxml=test-results/junit.xml --cov --cov-report=html"
+testpaths = ["tests"]
+markers = ["e2e: marks tests as end-to-end tests"]
+norecursedirs = ["*.egg", ".*", "build", "dist", "venv", "legacy"]
+junit_logging = "all"
+
+[tool.coverage.run]
+branch = true
+source = ["symphony"]
+omit = ["symphony/bdk/gen/*"]
+
+[tool.coverage.report]
+fail_under = 90.0
+
+[tool.liccheck]
+authorized_licenses = [
+    "BSD",
+    "GNU Library or Lesser General Public License (LGPL)",
+    "MIT",
+    "Apache Software",
+    "Apache-2.0",
+    "Python Software Foundation"
+]
+
+
+
+[tool.ruff]
+include = ["pyproject.toml", "symphony/**/*.py", "examples/**/*.py"]
+exclude = [
+    "symphony/bdk/gen",
+]
+
+target-version = "py39"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I"]
+ignore = ["E501"]
+
+[tool.ruff.format]
+quote-style = "double"
+

symphony_bdk_python-3.0.0b0/symphony/bdk/core/__init__.py

@@ -0,0 +1,12 @@
+"""Symphony BDK core package
+
+There is an outstanding issue with aiohttp and Python 3.8+ on Windows. This affects our client when using a
+proxy on Windows with Python 3.8+. As known workaround, the following code is meant to avoid this issue by detecting the
+operating system and setting WindowsSelectorEventLoopPolicy as event loop policy.
+"""
+
+import asyncio
+import os
+
+if os.name == "nt":
+    asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())

symphony_bdk_python-3.0.0b0/symphony/bdk/core/activity/__init__.py

@@ -0,0 +1 @@
+"""Package containing all modules related to the Activity API"""

symphony_bdk_python-3.0.0b0/symphony/bdk/core/activity/api.py

@@ -0,0 +1,67 @@
+from abc import ABC, abstractmethod
+from typing import Generic, TypeVar
+
+from symphony.bdk.gen.agent_model.v4_initiator import V4Initiator
+
+C = TypeVar("C")  # Context type
+E = TypeVar("E")  # Event type
+
+
+class ActivityContext(Generic[E]):
+    """
+    Base class for any activity context holder.
+    """
+
+    def __init__(self, initiator: V4Initiator, source_event: E):
+        """
+
+        :param initiator: The activity initiator  (i.e. the Symphony user that triggered an event in the chat)
+        :param source_event: The activity source real-time event.
+        """
+        self._initiator = initiator
+        self._source_event = source_event
+
+    @property
+    def initiator(self):
+        """
+
+        :return: The activity initiator  (i.e. the Symphony user that triggered an event in the chat)
+        """
+        return self._initiator
+
+    @property
+    def source_event(self):
+        """
+
+        :return: The activity source real-time event.
+        """
+        return self._source_event
+
+
+class AbstractActivity(ABC, Generic[C]):
+    """
+    Base abstract class for activities provided by the BDK. Provides a generic flow to process an incoming chat event.
+    """
+
+    @abstractmethod
+    def matches(self, context: C) -> bool:
+        """Matches the :py:class:`ActivityContext` to decide whether an :py:class:`AbstractActivity` can be executed
+        or not.
+
+        :param context: an instance of :py:class:`ActivityContext`
+        :return: True if activity has to be triggered, False otherwise.
+        """
+
+    @abstractmethod
+    async def on_activity(self, context: C):
+        """Contains the activity business logic. Executed only if the `matches` method returned a true value.
+
+        :param context: an instance of :py:class:`ActivityContext`
+        """
+
+    def before_matcher(self, context: C):
+        """This callback can be used to prepare :py:class:`ActivityContext` before actually processing the `matches`
+        method.
+
+        :param context: an instance of :py:class:`ActivityContext`
+        """

symphony_bdk_python-3.0.0b0/symphony/bdk/core/activity/command.py

@@ -0,0 +1,138 @@
+import logging
+
+from symphony.bdk.core.activity.api import AbstractActivity, ActivityContext
+from symphony.bdk.core.activity.exception import FatalActivityExecutionException
+from symphony.bdk.core.activity.parsing.arguments import Arguments
+from symphony.bdk.core.activity.parsing.command_token import MatchingUserIdMentionToken
+from symphony.bdk.core.activity.parsing.slash_command_pattern import SlashCommandPattern
+from symphony.bdk.core.service.exception import MessageParserError
+from symphony.bdk.core.service.message.message_parser import get_text_content_from_message
+from symphony.bdk.gen.agent_model.v4_initiator import V4Initiator
+from symphony.bdk.gen.agent_model.v4_message_sent import V4MessageSent
+
+logger = logging.getLogger(__name__)
+
+
+class CommandContext(ActivityContext[V4MessageSent]):
+    """Default implementation of the :py:class:`ActivityContext` handled by the :py:class:`CommandActivity`."""
+
+    def __init__(
+        self,
+        initiator: V4Initiator,
+        source_event: V4MessageSent,
+        bot_display_name: str,
+        bot_user_id: int = None,
+    ):
+        self._message_id = source_event.message.message_id
+        self._stream_id = source_event.message.stream.stream_id
+        self._bot_display_name = bot_display_name
+        self._bot_user_id = bot_user_id
+        self._arguments = None
+        try:
+            self._text_content = get_text_content_from_message(source_event.message)
+        except MessageParserError as exc:
+            raise FatalActivityExecutionException("Unable to parse presentationML") from exc
+        super().__init__(initiator, source_event)
+
+    @property
+    def message_id(self):
+        return self._message_id
+
+    @property
+    def stream_id(self):
+        return self._stream_id
+
+    @property
+    def text_content(self) -> str:
+        return self._text_content
+
+    @property
+    def bot_display_name(self) -> str:
+        return self._bot_display_name
+
+    @property
+    def bot_user_id(self) -> int:
+        return self._bot_user_id
+
+    @property
+    def arguments(self) -> Arguments:
+        return self._arguments
+
+
+class CommandActivity(AbstractActivity[CommandContext]):
+    """A command activity corresponds to any message sent in a chat where the bot is part of."""
+
+    def __init__(self):
+        self._bot_user_id = None
+
+    @property
+    def bot_user_id(self):
+        return self._bot_user_id
+
+    @bot_user_id.setter
+    def bot_user_id(self, bot_user_id):
+        self._bot_user_id = bot_user_id
+
+    def matches(self, context: CommandContext) -> bool:
+        pass
+
+    async def on_activity(self, context: CommandContext):
+        pass
+
+
+class SlashCommandActivity(CommandActivity):
+    """A slash command is a particular CommandActivity with three parameters:
+      - the command name
+      - if we should mention the bot
+      - the callback function
+
+    The Slash command is triggered if we receive a MESSAGESENT event with message text:
+      - "@{bot_display name} {name}" if ``requires_mention_bot`` is True
+      - "{name}" otherwise
+    """
+
+    def __init__(self, name, requires_mention_bot, callback, description=""):
+        """
+        :param name: the command name
+        :param requires_mention_bot: if the command requires the bot mention to trigger the slash command
+        :param callback: the coroutine to be executed if message text matches
+        """
+        super().__init__()
+        self._name = name
+        self._command_pattern = SlashCommandPattern(name)
+        self._requires_mention_bot = requires_mention_bot
+        self._callback = callback
+        self._description = description
+
+        if self._requires_mention_bot:
+            # The user id will be loaded in runtime in a lazy way
+            self._command_pattern.prepend_token(
+                MatchingUserIdMentionToken(lambda: self.bot_user_id)
+            )
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    def build_command_description(self) -> str:
+        return (
+            self._description + " (mention required)"
+            if self._requires_mention_bot
+            else self._description + " (mention not required)"
+        )
+
+    def matches(self, context: CommandContext) -> bool:
+        match_result = self._command_pattern.get_match_result(context.source_event.message)
+
+        if match_result.is_matching and match_result.arguments:
+            context._arguments = match_result.arguments
+
+        return match_result.is_matching
+
+    async def on_activity(self, context: CommandContext):
+        await self._callback(context)
+
+    def __eq__(self, o: object) -> bool:
+        if isinstance(o, SlashCommandActivity):
+            return self._name == o._name and self._requires_mention_bot == o._requires_mention_bot
+        return False

symphony_bdk_python-3.0.0b0/symphony/bdk/core/activity/exception.py

@@ -0,0 +1,5 @@
+"""Module containing all activities related exception."""
+
+
+class FatalActivityExecutionException(Exception):
+    """A Fatal error occurred during an activity execution flow"""

symphony_bdk_python-3.0.0b0/symphony/bdk/core/activity/help_command.py

@@ -0,0 +1,23 @@
+from symphony.bdk.core.activity.command import CommandContext, SlashCommandActivity
+from symphony.bdk.core.symphony_bdk import SymphonyBdk
+
+
+class HelpCommand(SlashCommandActivity):
+    """The help command is a particular CommandActivity which returns the list of all commands available for the
+    specific bot
+    The Slash command is triggered if we receive a MESSAGESENT event with message text:
+      - "@{bot_display name} /help"
+    """
+
+    def __init__(self, bdk: SymphonyBdk):
+        super().__init__("/help", True, None, "List available commands")
+        self._bdk = bdk
+
+    async def on_activity(self, context: CommandContext):
+        activity_list = self._bdk.activities().activity_list
+        help_message = ""
+        for act in activity_list:
+            help_message += "<li>" + act.name + " - " + act.build_command_description() + "</li>"
+        await self._bdk.messages().send_message(
+            context.stream_id, "<messageML><ul>" + help_message + "</ul></messageML>"
+        )