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.34.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.34-py3-none-any.whl (2.8 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: synqly-2.0.34.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.34.tar.gz
Algorithm Hash digest
SHA256 23966ac3fcf1c5a23dc5779e080241dbc7ab2c413ea22b5a6edb1e53515a329d
MD5 9aa2fb1a23d8f69a944db1db26e6ffd7
BLAKE2b-256 b0c4c04dfa3056b09180f4d582b93eefa52432d4ac39f4049f1de3f78c095960

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: synqly-2.0.34-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.34-py3-none-any.whl
Algorithm Hash digest
SHA256 8df736be994223d8d5decdcd2d11a4e816ce3dccc6ba7f6489a9d084de553b3e
MD5 75ef82f3e4d0c40d85e7c95c2824a0a1
BLAKE2b-256 d54d617139590d65ee26b987195b1f4fc3491b17fdeadb990942e69861efeb84

See more details on using hashes here.

Provenance

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