Skip to main content

Waylay Resources Service

This service manages Waylay Resources and related entities.

A Waylay Resource models a real-world device or abstract entity of your IoT solution, and provides a context when processing data in the Rule Engine.

You'll interact with the Waylay Resources API to create this Digital Twin model, a process that's also called resource provisioning.

This Python package is automatically generated based on the Waylay Resources OpenAPI specification (API version: 8.1.0) For more information, please visit the openapi specification.

It consists of a plugin for the waylay-sdk-core package, and contains the Resources api methods. Note that the typed model classes for all path params, query params, body params and responses for each of the api methods are contained in a separate package called waylay-sdk-resources-types.

Requirements.

This package requires Python 3.9+.

Installation

Normally this package is installed together with support for other services using the waylay-sdk umbrella package:

  • pip install waylay-sdk will install waylay-sdk-resources together with the SDK api packages for other services.
  • pip install waylay-sdk[types-resources] will additionally install the types package waylay-sdk-resources-types.
  • pip install waylay-sdk[types] will install the types packages for this and all other services.

Alternatively, you can install support for this resources service only, installing or extending an existing waylay-sdk-core:

  • pip install waylay-sdk-resources to only install api support for resources.
  • pip install waylay-sdk-resources[types] to additionally install type support for resources.

Usage

from pprint import pprint

# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError

# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()

# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-resources-types` is installed
from waylay.services.resources.models.version_response import VersionResponse
try:
    # Get Service Information
    # calls `GET /resources/v1/`
    api_response = await waylay_client.resources.about.get(
    )
    print("The response of resources.about.get:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling resources.about.get: %s\n" % e)

For more information, please visit the Waylay API documentation.

Metadata

Release files for waylay-sdk-resources 8.1.0.20240802

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-resources 8.1.0.20240802
File Size Uploaded Provenance Actions
waylay_sdk_resources-8.1.0.20240802.tar.gz 16.9 kB Without provenance Details for waylay_sdk_resources-8.1.0.20240802.tar.gz

Built distribution (wheel)

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

Total release size: 41.6 kB

Release files / waylay_sdk_resources-8.1.0.20240802.tar.gz

Download URL waylay_sdk_resources-8.1.0.20240802.tar.gz
Size 16.9 kB
Tags Source
SHA-256 checksum
How to use checksums
61011cf51ff979b3d4eda5e492355cb4c4463a59b188ae870c4b9e33de08b894
BLAKE2b-256 checksum
How to use checksums
675b920cf79f0be29734547b2d8bb54486868ad0a557b3ea64d91f3f5f15ecf3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / waylay_sdk_resources-8.1.0.20240802-py3-none-any.whl

Download URL waylay_sdk_resources-8.1.0.20240802-py3-none-any.whl
Size 24.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
25ad544505fd4ec338e8f07f65c3ab2511ccb0a9d52080a79951cad3d6150313
BLAKE2b-256 checksum
How to use checksums
6b0ee837548edf4cd4eb4a772a6f3d5e1192200ba6b4f76f017017e58236b55d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

Security for waylay-sdk-resources 8.1.0.20240802

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