crossplane
/
function-sdk-python
mirror of https://github.com/crossplane/function-sdk-python.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
The Python SDK for composition functions
47 Commits 10 Branches 7 Tags 462 KiB
Python 100%
Go to file
Nic Cope 9c7a3eba5d
Merge pull request #29 from negz/like-a-version 
Only run publish step once build is done
 		2024-01-03 18:51:59 -08:00
.github Only run publish step once build is done 2024-01-03 18:50:27 -08:00
crossplane/function Use Python-compatible versions 2024-01-03 18:37:34 -08:00
tests Add license headers 2023-11-21 19:06:10 -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 Use a single lint command 2023-11-19 18:00:36 -08:00
pyproject.toml Use Python-compatible versions 2024-01-03 18:37:34 -08:00
renovate.json Add renovate.json 2023-11-21 02:22:01 +00: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:

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