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:
- Follow the guide to writing a composition function in Python
- Learn about how composition functions work
- Read the package documentation
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.
If you just want to jump in and get started, consider using the function-template-python template repository.
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
# Format and lint the code.
hatch fmt
# Run unit tests.
hatch test
# Build an sdist and wheel.
hatch build