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-2.0.21.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

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

synqly-2.0.21-py3-none-any.whl (2.8 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: synqly-2.0.21.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for synqly-2.0.21.tar.gz
Algorithm Hash digest
SHA256 47b793093eb943aa4603c49ea44f2d2693bf323b06890589ac10a3f2d83697a8
MD5 e0507b2021b0788d397a00a6cc17421d
BLAKE2b-256 df7bfd80eeb11f7e66f865eece4d2a20f138c4d039d722921f5fbdecae76fa9b

See more details on using hashes here.

Provenance

The following attestation bundles were made for synqly-2.0.21.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-2.0.21-py3-none-any.whl.

File metadata

  • Download URL: synqly-2.0.21-py3-none-any.whl
  • Upload date:
  • Size: 2.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for synqly-2.0.21-py3-none-any.whl
Algorithm Hash digest
SHA256 7a35d039d0256c9da287ff75be1a94e18b981affd689abc273831731b760bc92
MD5 ac26979191d397c31b0f9fc0aff2e323
BLAKE2b-256 0cfaae6e7359c24794d757d588f39e042f1a7eddf832484bd851d15841041aed

See more details on using hashes here.

Provenance

The following attestation bundles were made for synqly-2.0.21-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