The Python SDK for composition functions
Go to file
Nic Cope e247d8766e Break the SDK out into its own repo
I prototyped this in https://github.com/negz/function-auto-python.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-19 13:37:50 -08:00
.github Break the SDK out into its own repo 2023-11-19 13:37:50 -08:00
crossplane/function Break the SDK out into its own repo 2023-11-19 13:37:50 -08:00
tests Break the SDK out into its own repo 2023-11-19 13:37:50 -08:00
.gitignore Initial commit 2023-11-20 15:00:23 -08:00
LICENSE Initial commit 2023-11-20 15:00:23 -08:00
README.md Break the SDK out into its own repo 2023-11-19 13:37:50 -08:00
pyproject.toml Break the SDK out into its own repo 2023-11-19 13:37:50 -08:00

README.md

function-sdk-python

CI GitHub release (latest SemVer)

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:

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, using ruff.
hatch run lint:check
hatch run lint:check-format

# Run unit tests.
hatch run test:unit

# Build an sdist and wheel
hatch build