Skip to main content

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 .

Download files

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

Source Distribution

synqly-1.0.161.tar.gz (2.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

synqly-1.0.161-py3-none-any.whl (5.9 MB view details)

Uploaded Python 3

File details

Details for the file synqly-1.0.161.tar.gz.

File metadata

  • Download URL: synqly-1.0.161.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for synqly-1.0.161.tar.gz
Algorithm Hash digest
SHA256 1d81ea64a5068f93a6069c25f46786391b02d3c647dc029e69367e52f679023b
MD5 6702ed4615d12bc208eaac8477815767
BLAKE2b-256 534044ae565d980f2be75f963e9d191eec2dd730ecc24d01642731ab898eea11

See more details on using hashes here.

Provenance

The following attestation bundles were made for synqly-1.0.161.tar.gz:

Publisher: sdk-publish.yml on Synqly/lepton

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file synqly-1.0.161-py3-none-any.whl.

File metadata

  • Download URL: synqly-1.0.161-py3-none-any.whl
  • Upload date:
  • Size: 5.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for synqly-1.0.161-py3-none-any.whl
Algorithm Hash digest
SHA256 4c119b207db8880f201d34400d15e0b049b9a2c4548681b311f4c5eefaae87af
MD5 ca23752568da34bd22b04096e1f2cb72
BLAKE2b-256 02e748dddb52ccdc07ab0875fe0adb6f9b319b6961cf42f0e6e1900854d86e8f

See more details on using hashes here.

Provenance

The following attestation bundles were made for synqly-1.0.161-py3-none-any.whl:

Publisher: sdk-publish.yml on Synqly/lepton

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page