The Python SDK for composition functions

Go to file

Nic Cope fde5b7ef84 Merge pull request #93 from crossplane/renovate/ubuntu-24.x chore(deps): update dependency ubuntu to v24		2024-10-09 20:02:22 -07:00
.github	chore(deps): update dependency ubuntu to v24	2024-10-10 03:00:53 +00:00
crossplane/function	Use class matches in resource.update()	2024-10-09 18:04:33 -07:00
tests	Use the new hatch test command to run tests	2024-10-09 19:54:19 -07:00
.gitignore	Generate and publish API docs to GitHub pages	2024-01-05 13:08:30 -08:00
LICENSE	Initial commit	2023-11-20 15:00:23 -08:00
README.md	Use the new hatch fmt command to run linters and formatting	2024-10-09 19:54:19 -07:00
pyproject.toml	Use the new hatch fmt command to run linters and formatting	2024-10-09 19:54:19 -07:00
renovate.json	Add renovate.json	2023-11-21 02:22:01 +00:00

README.md

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.

If you just want to jump in and get started, consider using the function-template-python template repository.

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

# Format and lint the code.
hatch fmt

# Run unit tests.
hatch test

# Build an sdist and wheel.
hatch build