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 .
2 maintainers
Release files for synqly 2.0.38
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| synqly-2.0.38.tar.gz | 1.3 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| synqly-2.0.38-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.2 MB
Release files / synqly-2.0.38.tar.gz
| Download URL | synqly-2.0.38.tar.gz |
|---|---|
| Size | 1.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
83dd1f55a9b4aac3244894f19ed0fa070ff749c23790c4323e1d85c1f17b2bfa
|
|
BLAKE2b-256 checksum How to use checksums |
d285233a608e55c2d8e9f30dbf40e14b7917edb93e108982c47c10ae39d8a08e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 20, 2026.
Transparency logRelease files / synqly-2.0.38-py3-none-any.whl
| Download URL | synqly-2.0.38-py3-none-any.whl |
|---|---|
| Size | 2.9 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1143bbcbce4c4c8087749651cd01cbb8c15f2dfc8a2dd58c149598598b92fb9f
|
|
BLAKE2b-256 checksum How to use checksums |
fb56f26ad5448a2bb1b79f46e2f3506ad90e790bee662bec7f5636f14f4c197a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 20, 2026.
Transparency log
