The Python SDK for Crossplane composition functions
Project description
function-sdk-python
The Python SDK for writing composition functions.
This SDK is currently a beta. We try to avoid breaking changes, but it will not have a stable API until it reaches v1.0.0. It follows the same contributing guidelines as Crossplane.
To learn how to use this SDK:
The RunFunctionRequest
and RunFunctionResponse
types provided by this SDK
are generated from a proto3 protocol buffer schema. Their fields behave
similarly to built-in Python types like lists and dictionaries, but there are
some differences. Read the generated code documentation to familiarize yourself
with the the differences.
Contributing
This project follows the Crossplane contributing guidelines, where applicable to Python. It is linted, tested, and built using Hatch.
Some useful commands:
# Generate gRPC stubs.
hatch run generate:protoc
# Lint the code.
hatch run lint:check
# Run unit tests.
hatch run test:unit
# Build an sdist and wheel.
hatch build
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for crossplane_function_sdk_python-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a3b17dabf2adafef6d5e899c29c8e3c7e23ee9d656a0009822bc35ffe266f65 |
|
MD5 | 57e4cff7b2eb4e8d01374c5028a6b35b |
|
BLAKE2b-256 | 74bfcbeaa8866fdcdd6f085373c43b036455b9b4938eddf6f8ae60d9d81ccf7c |
Hashes for crossplane_function_sdk_python-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01a8bed2e62cdfb38e67a12284c364520fb6449e05d84f87d159ed9c280dc19b |
|
MD5 | 7bb9236b058616c1a281f4f719447c02 |
|
BLAKE2b-256 | 342acb1ad693839ff159c740cb4d5c3fbcf9d12271048e53d6b5969be59e997c |