KUKSA Python SDK

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. For more details see the KUKSA Python SDK Docker documentation.

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.