A template for writing a composition function in Python.
To learn how to use this template:
If you just want to jump in and get started:
function-template-python
with your function's name in
package/crossplane.yaml
.RunFunction
in function/fn.py
test/test_fn.py
README.md
, to be about your function!This template uses Python, Docker, and the Crossplane CLI to build functions.
# Run the code in development mode, for crossplane beta render
hatch run development
# Lint and format the code - see pyproject.toml
hatch fmt
# Run unit tests - see tests/test_fn.py
hatch test
# Build the function's runtime image - see Dockerfile
$ docker build . --tag=runtime
# Build a function package - see package/crossplane.yaml
$ crossplane xpkg build -f package --embed-runtime-image=runtime