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
4 Commits 6 Branches 0 Tags 327 KiB
Python 80%
Dockerfile 20%
Go to file
Nic Cope 36cec82552
Merge pull request #2 from negz/orgio 
Fix Python URL
 		2023-11-21 18:52:08 -08:00
.github Add function-template-python 2023-11-21 18:24:54 -08:00
example Add function-template-python 2023-11-21 18:24:54 -08:00
function Add function-template-python 2023-11-21 18:24:54 -08:00
package Add function-template-python 2023-11-21 18:24:54 -08:00
tests Add function-template-python 2023-11-21 18:24:54 -08: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 Python URL 2023-11-21 18:45:01 -08:00
pyproject.toml Add function-template-python 2023-11-21 18:24:54 -08: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 pyproject.toml and 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.

# 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