Skip to main content

KUKSA Python Client and SDK

Project description

KUKSA Python SDK

kuksa.val Logo

KUKSA Python Client and SDK is a part of the open source project Eclipse KUKSA. More about Eclipse KUKSA can be found in the repository.

Introduction

KUKSA Python SDK provides both a command-line interface (CLI) and a standalone library to interact with either KUKSA Server or KUKSA Databroker.

Building and Installing the KUKSA Python SDK

The fastest way to start using KUKSA Python SDK is to install a pre-built version from pypi.org:

pip install kuksa-client

If you want to install from sources instead see the KUKSA Python SDK Build documentation.

Using the Command Line Interface (CLI)

After you have installed the kuksa-client package via pip you can run the test client CLI directly by executing:

kuksa-client

With default CLI arguments, the client will try to connect to a local Databroker, e.g. a server supporting the kuksa.val.v1 protocol without using TLS. This is equivalent to executing

kuksa-client grpc://127.0.0.1:55555

More details on how to use the CLI is available in the KUKSA Python SDK CLI documentation

Using Docker for the CLI

The KUKSA Python SDK CLI is available as a prebuilt docker container.

Using KUKSA Python SDK as library

The KUKSA Python SDK provides three APIS for connecting and communicating with KUKSA Server and KUKSA Databroker. For more details see the KUKSA Python SDK Library documentation.

Contributing to KUKSA Python SDK

The KUKSA project welcomes contributions.

See the KUKSA Python SDK Contribition document for formal requirements.

Development and Troubleshooting

For information on tools useful for KUKSA Python SDK development environment and help on troubleshooting frequent problems please visit the KUKSA Python SDK development and troubleshooting documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kuksa_client-0.5.1.tar.gz (65.4 kB view details)

Uploaded Source

Built Distribution

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

kuksa_client-0.5.1-py3-none-any.whl (82.0 kB view details)

Uploaded Python 3

File details

Details for the file kuksa_client-0.5.1.tar.gz.

File metadata

  • Download URL: kuksa_client-0.5.1.tar.gz
  • Upload date:
  • Size: 65.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kuksa_client-0.5.1.tar.gz
Algorithm Hash digest
SHA256 214825aebb8b0a65e4e73604280d856ff2477e0905d0deb8d8db843db5b809a5
MD5 7c1e39aa968a8dca88077cc22dc456ee
BLAKE2b-256 2cf1e64b00507632ff9295f1ad5db19d7464eb582ee63e5b811b456b0a4b3fb5

See more details on using hashes here.

Provenance

The following attestation bundles were made for kuksa_client-0.5.1.tar.gz:

Publisher: release.yml on eclipse-kuksa/kuksa-python-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kuksa_client-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: kuksa_client-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 82.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kuksa_client-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ce94bd010f984132d3a1a06cf4c8dee0fcc70c0b9445f56149450781e2003634
MD5 5866c3b694e6baac3486a79212b96a19
BLAKE2b-256 fbfd36e935c88d2493a23ba99d3fa3f825e2606a3356dccf762b4c700e83d2a9

See more details on using hashes here.

Provenance

The following attestation bundles were made for kuksa_client-0.5.1-py3-none-any.whl:

Publisher: release.yml on eclipse-kuksa/kuksa-python-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page