Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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 is considered an extension of the waylay-sdk-resources package, and it consists of the typed model classes for all path params, query params, body params and responses for each of the api methods in waylay-sdk-resources.

Requirements.

This package requires Python 3.9+.

Installation

Typically this package is installed when installing the waylay-sdk-core package to enable the service's functionality. When the service api methods are required, waylay-sdk-resources is included in:

  • pip install waylay-sdk-core[resources] to install waylay-sdk-core along with only this service, or
  • pip install waylay-sdk-core[services] to install waylay-sdk-core along with all services. When the typed models are required, both waylay-sdk-resources and waylay-sdk-resources-types are included in:
  • pip install waylay-sdk-core[resources,resources-types] to install waylay-sdk-core along with only this service including the typed models, or
  • pip install waylay-sdk-core[services,services-types] to install waylay-sdk-core along with all services along with the typed models.

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-types 8.1.0a20240415

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-types 8.1.0a20240415
File Size Uploaded Provenance Actions
waylay_sdk_resources_types-8.1.0a20240415.tar.gz 27.9 kB Without provenance Details for waylay_sdk_resources_types-8.1.0a20240415.tar.gz

Built distribution (wheel)

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

Total release size: 128.1 kB

Release files / waylay_sdk_resources_types-8.1.0a20240415.tar.gz

Download URL waylay_sdk_resources_types-8.1.0a20240415.tar.gz
Size 27.9 kB
Tags Source
SHA-256 checksum
How to use checksums
c478ef025141a39cd24abaeea3ac3b06d0315bba95669578f4797692b3f9b4a8
BLAKE2b-256 checksum
How to use checksums
ee622f171321877c27f4aaefbb1b1d5972d2eb5397e3ddf23d23ef14a66aa2c4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.8

Release files / waylay_sdk_resources_types-8.1.0a20240415-py3-none-any.whl

Download URL waylay_sdk_resources_types-8.1.0a20240415-py3-none-any.whl
Size 100.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
958bd39fd6af75bec89ac94e8101316da2f899195007d211e6472cc10797176d
BLAKE2b-256 checksum
How to use checksums
d4690a97f25fcdf2b176ab3961bd2892d0cd60de5119894468789ffcfa159938
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.8

Security for waylay-sdk-resources-types 8.1.0a20240415

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