SDK for Synqly APIs
Project description
Synqly Python SDK
This repository contains the SynqlyPythonClient
SDK package, which can be used to integrate a Python application with Synqly APIs. All Synqly SDKs require a valid Synqly Organization token to use.
If you aren't yet a Synqly customer, please feel free to Schedule a Demo.
The Python Pydantic type checker can, in cases, be stricter than other SDKs. If you run into any type resolution errors such as the following, please report them on Slack and we'll work on patching it as quickly as possible.
Error configuring event logging for Tenant XYZ: 1 validation error for ProviderConfig_Siem
config
none is not an allowed value (type=type_error.none.not_allowed)
Import the SDK
To install the SynqlyPythonClient
to your local Python environment, run the following command:
pip3 install git+https://github.com/Synqly/python-sdk.git
You should now be able to import packages from the SynqlyPythonClient
as follows:
from synqly import engine
from synqly import management as mgmt
For more detailed examples of how to use the Synqly Python SDK, please refer to the examples
directory in this repository. Each sub-directory in examples
contains a standalone example of how to work with a particular Synqly Connector.
Local Development
While the files under /src
are auto-generated, it can sometimes be useful to install a local copy of the SDK in order to debug issues such as type mismatches. The following command will install the local version of SynqlyPythonClient
, overriding the upstream repository.
cd ~/python-sdk
pip install -e .
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file synqly-0.3.12.tar.gz
.
File metadata
- Download URL: synqly-0.3.12.tar.gz
- Upload date:
- Size: 1.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19c8ed1c4d82970c706980a16698fd1210f3db42a56e891b9fd2e642d128c716 |
|
MD5 | 4af684ecf523d7fb671d19fdc78d8726 |
|
BLAKE2b-256 | 07a345c7b62a94890cfda854df610860068eb31f7ba52136442a13b691547a9f |
File details
Details for the file synqly-0.3.12-py3-none-any.whl
.
File metadata
- Download URL: synqly-0.3.12-py3-none-any.whl
- Upload date:
- Size: 5.2 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b5a9ff1b181895bff86e5948aae02ea77d303ac0e2ace45660826dbb6c27e91b |
|
MD5 | ed32c4bd97111acdf310c7cc47500852 |
|
BLAKE2b-256 | 11fab7ef6eb9e3fe7c2511e6a9d644ec2be4632c334dfbcc0b4cd87877a6d307 |