Skip to main content

Symphony Bot Development Kit for Python

Project description

FINOS - Incubating License Python Pypi GitHub Workflow Status (branch)

Symphony BDK for Python

This is the Symphony BDK for Python to help develop bots and interact with the Symphony REST APIs.

Installation and getting started

The reference documentation includes detailed installation instructions as well as a comprehensive getting started 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 in order to manage dependencies, build, run tests and publish. To install poetry, follow instructions here.

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.0.x one. It will only consist in delivering the next improvements of the BDK.

Contributing

In order to get in touch with the project team, please open a GitHub Issue. Alternatively, you can email/subscribe to symphony@finos.org.

  1. Fork it
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Read our contribution guidelines and Community 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

License

Copyright 2021 Symphony LLC

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

symphony_bdk_python-2.0.1.tar.gz (247.1 kB view details)

Uploaded Source

Built Distribution

symphony_bdk_python-2.0.1-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

Details for the file symphony_bdk_python-2.0.1.tar.gz.

File metadata

  • Download URL: symphony_bdk_python-2.0.1.tar.gz
  • Upload date:
  • Size: 247.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.12 Linux/5.8.0-1042-azure

File hashes

Hashes for symphony_bdk_python-2.0.1.tar.gz
Algorithm Hash digest
SHA256 4989c50ae81a113cad47cd16e677b59e950c9becefc90d326ed3d17c58471c26
MD5 b08bc11c23c66b84e9a17cadfac7b112
BLAKE2b-256 4947d3d3bddd01c9103ff04e3f05a1fa85b5e275ca7297e3de1d6bc23c821c65

See more details on using hashes here.

File details

Details for the file symphony_bdk_python-2.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for symphony_bdk_python-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 778ef39e029d4a35f060d0490e1b45b00e19b20e0e59bf8decd31204b1867e65
MD5 7cdccce45615610023bd2212cd9407d0
BLAKE2b-256 f715c9ac18ab39c65db2fbc3c0e51451deef750bbb7aae3a6d40cf43f17593c9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page