The Python SDK for composition functions
Go to file
Nic Cope df655cabec Use class matches in resource.update()
This was introduced in 3.10, and seems like a much better way to handle
matching a type.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2024-10-09 18:04:33 -07:00
.github chore(deps): update pypa/gh-action-pypi-publish action to v1.10.3 2024-10-04 04:42:12 +00:00
crossplane/function Use class matches in resource.update() 2024-10-09 18:04:33 -07:00
tests Add a resource.update convenience function 2024-10-09 18:04:33 -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 Link guide, package docs 2024-01-12 16:04:21 -08:00
pyproject.toml Don't lint (generated) testdata 2024-10-09 18:04:33 -07:00
renovate.json Add renovate.json 2023-11-21 02:22:01 +00:00

README.md

function-sdk-python

CI GitHub release (latest SemVer) PyPI - Version

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

# Lint the code.
hatch run lint:check

# Run unit tests.
hatch run test:unit

# Build an sdist and wheel.
hatch build