crossplane
/
function-template-python
mirror of https://github.com/crossplane/function-template-python.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
A template for writing a composition function in Python
126 Commits 6 Branches 0 Tags 324 KiB
Python 80%
Dockerfile 20%
Go to file
renovate[bot] 605ae2c909
chore(deps): update dependency ruff to v0.6.1 		2024-08-16 20:22:58 +00:00
.github chore(deps): update docker/build-push-action action to v6 2024-06-17 17:09:32 +00:00
example Add a 'development' convenience script 2024-01-11 14:17:25 -08:00
function Switch to crossplane-function-sdk-python from pip 2024-01-04 16:43:08 -08:00
package Add an Input CRD 2024-01-09 16:59:18 -08:00
tests fix(tests): fix want/got mapping in test output 2024-04-02 09:50:05 -05:00
.gitignore Initial commit 2023-11-21 13:48:35 -08:00
Dockerfile Add function-template-python 2023-11-21 18:24:54 -08:00
LICENSE Initial commit 2023-11-21 13:48:35 -08:00
README.md Fix link reference to python sdk documentation 2024-02-01 10:05:31 +01:00
pyproject.toml chore(deps): update dependency ruff to v0.6.1 2024-08-16 20:22:58 +00:00
renovate.json Add renovate.json 2023-11-21 21:48:54 +00:00

README.md

function-template-python

CI

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:

  1. Replace function-template-python with your function's name in package/crossplane.yaml.
  2. Add your logic to RunFunction in function/fn.py
  3. Add tests for your logic in test/test_fn.py
  4. Update this file, 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 the code - see pyproject.toml
hatch run lint:check

# Run unit tests - see tests/test_fn.py
hatch run test:unit

# 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