symphony_bdk_python 2.8.0__tar.gz → 2.9.1__tar.gz

symphony_bdk_python-2.9.1/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.3
+Name: symphony_bdk_python
+Version: 2.9.1
+Summary: Symphony Bot Development Kit for Python
+License: Apache-2.0
+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
+Requires-Dist: PyJWT (>=2.10.0,<3.0.0)
+Requires-Dist: aiohttp (>=3.10.2,<4.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: 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 (>=1.26.19,<2.0.0)
+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.8%20%7C%203.9-blue)](https://www.python.org/downloads/release/python-3)
+[![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://developers.symphony.com/restapi/reference).
+
+## 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.8 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 pylint scan locally: `poetry run pylint <module_name>`
+- Generate documentation locally: `cd docsrc && make html`
+
+### 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. 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-2.9.1/README.md

@@ -0,0 +1,87 @@
+[![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.8%20%7C%203.9-blue)](https://www.python.org/downloads/release/python-3)
+[![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://developers.symphony.com/restapi/reference).
+
+## 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.8 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 pylint scan locally: `poetry run pylint <module_name>`
+- Generate documentation locally: `cd docsrc && make html`
+
+### 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. 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-2.8.0 → symphony_bdk_python-2.9.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "symphony_bdk_python"
-version = "2.8.0"
+version = "2.9.1"
 license = "Apache-2.0"
 description = "Symphony Bot Development Kit for Python"
 readme = "README.md"
@@ -12,14 +12,14 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = ">3.9.0,<3.9.1 || >3.9.1,<4.0"
 nulltype = "^2.3.1"
 python-dateutil = "^2.8.2"
 urllib3 = "^1.26.19"
 aiohttp = "^3.10.2"
 pyyaml = "^6.0"
-PyJWT = "^2.3.0"
-cryptography = "^43.0.1"
+PyJWT = "^2.10.0"
+cryptography = "^44.0.1"
 tenacity = "^8.0.1"
 defusedxml = "^0.7.1"
 docutils = "0.16"
@@ -30,6 +30,7 @@ pylint = "^2.6.0"
 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"
@@ -37,6 +38,9 @@ safety = "^2.2.0"
 liccheck = "^0.6.2"
 coverage = {version = "^6.0b1", extras = ["toml"]}
 
+[tool.poetry.requires-plugins]
+poetry-plugin-export = ">=1.8"
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"

{symphony_bdk_python-2.8.0 → symphony_bdk_python-2.9.1}/symphony/bdk/core/auth/auth_session.py

@@ -1,12 +1,15 @@
 """Module containing session handle classes.
 
 """
+from datetime import datetime, timezone
 import logging
 
 from symphony.bdk.core.auth.exception import AuthInitializationError
 
 logger = logging.getLogger(__name__)
 
+EXPIRATION_SAFETY_BUFFER_SECONDS = 5
+
 
 class AuthSession:
     """RSA Authentication session handle to get session and key manager tokens from.
@@ -21,7 +24,9 @@ class AuthSession:
         """
         self._session_token = None
         self._key_manager_token = None
+        self._auth_token = None
         self._authenticator = authenticator
+        self._expire_at = -1
 
     async def refresh(self):
         """Trigger re-authentication to refresh the tokens.
@@ -40,6 +45,26 @@ class AuthSession:
             self._session_token = await self._authenticator.retrieve_session_token()
         return self._session_token
 
+    @property
+    async def auth_token(self):
+        """Auth token request calls the same endpoint that session token.
+        Therefore, session token is updated unintentionally,
+         since there's no explicit way to update authorization token exclusively
+         : return: (str) authorization_token like Bearer eyJh...
+        """
+
+        if (
+            self._auth_token
+            and self._expire_at
+            > datetime.now(timezone.utc).timestamp() + EXPIRATION_SAFETY_BUFFER_SECONDS
+        ):
+            return self._auth_token
+        token, expire_at = await self._authenticator.retrieve_session_token_object()
+        self._expire_at = expire_at
+        self._auth_token = token.authorization_token
+        self._session_token = token.token
+        return self._auth_token
+
     @property
     async def key_manager_token(self):
         """

{symphony_bdk_python-2.8.0 → symphony_bdk_python-2.9.1}/symphony/bdk/core/auth/bot_authenticator.py

@@ -1,8 +1,9 @@
 """Module containing BotAuthenticator classes.
 """
+from typing import Optional, Tuple
 from abc import ABC, abstractmethod
 
-from symphony.bdk.core.auth.jwt_helper import create_signed_jwt
+from symphony.bdk.core.auth.jwt_helper import create_signed_jwt, generate_expiration_time
 from symphony.bdk.core.config.model.bdk_bot_config import BdkBotConfig
 from symphony.bdk.core.config.model.bdk_retry_config import BdkRetryConfig
 from symphony.bdk.core.retry import retry
@@ -11,6 +12,7 @@ from symphony.bdk.gen.api_client import ApiClient
 from symphony.bdk.gen.auth_api.certificate_authentication_api import CertificateAuthenticationApi
 from symphony.bdk.gen.login_api.authentication_api import AuthenticationApi
 from symphony.bdk.gen.login_model.authenticate_request import AuthenticateRequest
+from symphony.bdk.gen.login_model.token import Token
 
 
 class BotAuthenticator(ABC):
@@ -30,6 +32,17 @@ class BotAuthenticator(ABC):
         """
         return await self._authenticate_and_get_token(self._session_auth_client)
 
+    async def retrieve_session_token_object(self) -> Tuple[Token, int]:
+        """Authenticates and retrieves a new auth token.
+
+        :return: retrieved token object + expiration date.
+        """
+        expire_at = generate_expiration_time()
+        token = await self._authenticate_and_get_token_object(
+            self._session_auth_client, expire_at
+        )
+        return token, expire_at
+
     async def retrieve_key_manager_token(self) -> str:
         """Authenticated and retrieved a new key manager session.
 
@@ -58,11 +71,21 @@ class BotAuthenticatorRsa(BotAuthenticator):
 
     @retry(retry=authentication_retry)
     async def _authenticate_and_get_token(self, api_client: ApiClient) -> str:
-        jwt = create_signed_jwt(self._bot_config.private_key, self._bot_config.username)
-        req = AuthenticateRequest(token=jwt)
+        token_object = await self._authenticate_and_get_token_object(api_client)
+        return token_object.token
 
-        token = await AuthenticationApi(api_client).pubkey_authenticate_post(req)
-        return token.token
+    @retry(retry=authentication_retry)
+    async def _authenticate_and_get_token_object(
+        self, api_client: ApiClient, expire_at: Optional[int] = None
+    ) -> Token:
+        """Calls pubkey auth endpoint with signed jwt token.
+        :return: token object which might contain a few tokens inside
+        """
+        jwt = create_signed_jwt(
+            self._bot_config.private_key, self._bot_config.username, expire_at
+        )
+        req = AuthenticateRequest(token=jwt)
+        return await AuthenticationApi(api_client).pubkey_authenticate_post(req)
 
 
 class BotAuthenticatorCert(BotAuthenticator):

{symphony_bdk_python-2.8.0 → symphony_bdk_python-2.9.1}/symphony/bdk/core/auth/jwt_helper.py

@@ -2,7 +2,7 @@
 """
 import datetime
 
-import jwt
+from jwt import PyJWT, DecodeError, ExpiredSignatureError
 from cryptography.hazmat.primitives.serialization import Encoding, PublicFormat
 from cryptography.x509 import load_pem_x509_certificate
 
@@ -13,6 +13,7 @@ JWT_ENCRYPTION_ALGORITHM = "RS512"
 
 DEFAULT_EXPIRATION_SECONDS = (5 * 50) - 10
 
+jwt = PyJWT({"verify_sub": False})
 
 def create_signed_jwt(private_key_config: BdkRsaKeyConfig, username: str, expiration: int = None) -> str:
     """Creates a JWT with the provided user name and expiration date, signed with the provided private key.
@@ -57,10 +58,20 @@ def validate_jwt(jwt_token: str, certificate: str, allowed_audience: str) -> dic
     try:
         return jwt.decode(jwt_token, _parse_public_key_from_x509_cert(certificate),
                           algorithms=[JWT_ENCRYPTION_ALGORITHM], audience=allowed_audience)
-    except (jwt.DecodeError, jwt.ExpiredSignatureError) as exc:
+    except (DecodeError, ExpiredSignatureError) as exc:
         raise AuthInitializationError("Unable to validate the jwt") from exc
 
 
+def generate_expiration_time() -> int:
+    """Generates integer timestamp value for jwt token
+    :return: timestamp value
+    """
+    return int(
+        datetime.datetime.now(datetime.timezone.utc).timestamp()
+        + DEFAULT_EXPIRATION_SECONDS
+    )
+
+
 def _parse_public_key_from_x509_cert(certificate: str) -> str:
     """Returns the public key in PEM format given a X509 certificate content in PEM format
 

symphony_bdk_python-2.8.0/PKG-INFO

@@ -1,103 +0,0 @@
-Metadata-Version: 2.1
-Name: symphony_bdk_python
-Version: 2.8.0
-Summary: Symphony Bot Development Kit for Python
-Home-page: https://github.com/finos/symphony-bdk-python
-License: Apache-2.0
-Author: Symphony Platform Solutions
-Author-email: symphony@finos.org
-Requires-Python: >=3.8,<4.0
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-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-Dist: PyJWT (>=2.3.0,<3.0.0)
-Requires-Dist: aiohttp (>=3.10.2,<4.0.0)
-Requires-Dist: cryptography (>=43.0.1,<44.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: 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 (>=1.26.19,<2.0.0)
-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 - Incubating](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg)](https://finosfoundation.atlassian.net/wiki/display/FINOS/Incubating)
-[![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.8%20%7C%203.9-blue)](https://www.python.org/downloads/release/python-3)
-[![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://developers.symphony.com/restapi/reference).
-
-## Installation and getting started
-The [reference documentation](https://symphony-bdk-python.finos.org/) includes detailed
-installation instructions as well as a comprehensive
-[getting started](https://symphony-bdk-python.finos.org/markdown/getting_started.html)
-guide.
-
-## Build from source
-
-The Symphony BDK uses and requires Python 3.8 or higher. Be sure you have it installed before going further.
-
-We use [poetry](https://python-poetry.org/) in order to manage dependencies, build, run tests and publish.
-To install poetry, follow instructions [here](https://python-poetry.org/docs/#installation).
-
-On the first time, run `poetry install`. Then run `poetry build` to build the sdist and wheel packages.
-To run the tests, use `poetry run pytest`.
-
-It is possible to run pylint scan locally (on a specific file or package) executing the following command:
-`poetry run pylint <module_name>`.
-
-To generate locally the Sphinx documentation, run: `cd docsrc && make html`.
-
-## Roadmap
-
-Our next milestone is the [2.5.x](https://github.com/finos/symphony-bdk-python/milestone/6) one.
-It will only consist in delivering the next improvements and bug fixes of the BDK.
-
-
-## Contributing
-In order to get in touch with the project team, please open a [GitHub Issue](https://github.com/finos/symphony-bdk-python/issues).
-Alternatively, you can email/subscribe to [symphony@finos.org](https://groups.google.com/a/finos.org/g/symphony).
-
-1. Fork it
-2. Create your feature branch (`git checkout -b feature/fooBar`)
-3. Read our [contribution guidelines](CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
-4. Commit your changes (`git commit -am 'Add some fooBar'`)
-5. Push to the branch (`git push origin feature/fooBar`)
-6. Create a new Pull Request
-
-_NOTE:_ Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active,
-executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active
-Corporate Contribution License Agreement (CCLA) executed with FINOS.
-Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool.
-Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.
-
-*Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org)*
-
-### Update generated code
-While contributing to the project, you might need to update the generated code.
-Python BDK uses [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator/) to generate code. In order to customise the templates, a fork has been created in [https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0](https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0).  
-Here are the steps to follow:
-- Checkout the latest branch of the fork (currently [sym-python-5.5.0](https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0))
-- Update the fork source code, review and merge it
-- Generate a jar file in `openapi-generatormodules/openapi-generator-cli/target/openapi-generator-cli.jar`:
-  - Using maven: `mvn clean install -Dmaven.test.skip=true && mvn clean package -Dmaven.test.skip=true`. _You can also use IntelliJ's build button to build the project and generate the jar_
-- Copy the jar in Python BDK repository `symphony-api-client-python/api_client_generation/openapi-generator-cli.jar`
-- Execute the generation script `./generate.sh` and commit and push you new code along with the new 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-2.8.0/README.md

@@ -1,72 +0,0 @@
-[![FINOS - Incubating](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg)](https://finosfoundation.atlassian.net/wiki/display/FINOS/Incubating)
-[![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.8%20%7C%203.9-blue)](https://www.python.org/downloads/release/python-3)
-[![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://developers.symphony.com/restapi/reference).
-
-## Installation and getting started
-The [reference documentation](https://symphony-bdk-python.finos.org/) includes detailed
-installation instructions as well as a comprehensive
-[getting started](https://symphony-bdk-python.finos.org/markdown/getting_started.html)
-guide.
-
-## Build from source
-
-The Symphony BDK uses and requires Python 3.8 or higher. Be sure you have it installed before going further.
-
-We use [poetry](https://python-poetry.org/) in order to manage dependencies, build, run tests and publish.
-To install poetry, follow instructions [here](https://python-poetry.org/docs/#installation).
-
-On the first time, run `poetry install`. Then run `poetry build` to build the sdist and wheel packages.
-To run the tests, use `poetry run pytest`.
-
-It is possible to run pylint scan locally (on a specific file or package) executing the following command:
-`poetry run pylint <module_name>`.
-
-To generate locally the Sphinx documentation, run: `cd docsrc && make html`.
-
-## Roadmap
-
-Our next milestone is the [2.5.x](https://github.com/finos/symphony-bdk-python/milestone/6) one.
-It will only consist in delivering the next improvements and bug fixes of the BDK.
-
-
-## Contributing
-In order to get in touch with the project team, please open a [GitHub Issue](https://github.com/finos/symphony-bdk-python/issues).
-Alternatively, you can email/subscribe to [symphony@finos.org](https://groups.google.com/a/finos.org/g/symphony).
-
-1. Fork it
-2. Create your feature branch (`git checkout -b feature/fooBar`)
-3. Read our [contribution guidelines](CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
-4. Commit your changes (`git commit -am 'Add some fooBar'`)
-5. Push to the branch (`git push origin feature/fooBar`)
-6. Create a new Pull Request
-
-_NOTE:_ Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active,
-executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active
-Corporate Contribution License Agreement (CCLA) executed with FINOS.
-Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool.
-Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.
-
-*Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org)*
-
-### Update generated code
-While contributing to the project, you might need to update the generated code.
-Python BDK uses [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator/) to generate code. In order to customise the templates, a fork has been created in [https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0](https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0).  
-Here are the steps to follow:
-- Checkout the latest branch of the fork (currently [sym-python-5.5.0](https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0))
-- Update the fork source code, review and merge it
-- Generate a jar file in `openapi-generatormodules/openapi-generator-cli/target/openapi-generator-cli.jar`:
-  - Using maven: `mvn clean install -Dmaven.test.skip=true && mvn clean package -Dmaven.test.skip=true`. _You can also use IntelliJ's build button to build the project and generate the jar_
-- Copy the jar in Python BDK repository `symphony-api-client-python/api_client_generation/openapi-generator-cli.jar`
-- Execute the generation script `./generate.sh` and commit and push you new code along with the new 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)