Skip to main content

Waylay Python SDK

Python SDK for the Waylay Platform.

This waylay-sdk-core package provides a basic SDK client for the Waylay REST apis.

See Waylay Docs for documentation.

Installation

This package requires a python runtime 3.10 or higher.

The basic client can be installed with

pip install waylay-sdk-core

This client provides configuration, authorization and plugin features for the SDK.

It includes a generic http client to make authenticated calls to the services available on your Waylay gateway endpoint.

Support for specific Waylay services or tools is provided by separate extension packages.

See waylay-sdk to install a client that includes the recommended extensions.

Basic usage

Interactive Authentication

When used outside the Waylay platform (e.g. in a python notebook) the client requires you to provide

  • the gateway endpoint: api.waylay.io for Enterprise users,
  • an API key-secret pair: see Waylay Console at >Settings>Authentication keys.
from waylay.sdk import WaylayClient

# this will interactively request the gateway and credentials on first usage.
client = WaylayClient.from_profile()

# list the available service packages
client.services

# use the generic api client to see the status page of the 'registry' service.
resp = await client.api_client.request('GET', '/registry/v2')

Credentials and endpoints are stored in a local profile file (you can have multiple such profiles). Other authentication methods are available (JWToken, pass apiKey/Secret directly)

Metadata

Release files for waylay-sdk-core 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for waylay-sdk-core 1.0.0
File Size Uploaded Provenance Actions
waylay_sdk_core-1.0.0.tar.gz 29.2 kB Without provenance Details for waylay_sdk_core-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for waylay-sdk-core 1.0.0
File Interpreter ABI Platform Actions
waylay_sdk_core-1.0.0-py3-none-any.whl Python 3 none any Details for waylay_sdk_core-1.0.0-py3-none-any.whl

Total release size: 65.8 kB

Release files / waylay_sdk_core-1.0.0.tar.gz

Download URL waylay_sdk_core-1.0.0.tar.gz
Size 29.2 kB
Tags Source
SHA-256 checksum
How to use checksums
2a788bebf1008925aa6149fdbb7f1f17f2beab4c7b490d1faf563199c00154a8
BLAKE2b-256 checksum
How to use checksums
6bd7dbfe6c8d700042f30e6af8538734d236091722bc80691fe11ca69e4a0b9c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.14

Release files / waylay_sdk_core-1.0.0-py3-none-any.whl

Download URL waylay_sdk_core-1.0.0-py3-none-any.whl
Size 36.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9db08a3fae7ef4e87a97e49e1554f49274a131640ce751200afa5e12046e7d9b
BLAKE2b-256 checksum
How to use checksums
8329d17d025c9bd3382146e78e637266877f73b28842af6eb048f63c3796a2e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.14

Security for waylay-sdk-core 1.0.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page