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

Add PyPI badge, function-template-python link 

I considered adding instructions to pip install this package, but
decided against it. I think almost everyone should be using the template
instead.

Signed-off-by: Nic Cope <nicc@rk0n.org>
This commit is contained in:
Nic Cope 2024-01-04 16:35:54 -08:00
parent aa3e0e2c64
commit 25f400bb45
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,5 +1,7 @@
# function-sdk-python
[![CI](https://github.com/crossplane/function-sdk-python/actions/workflows/ci.yml/badge.svg)](https://github.com/crossplane/function-sdk-python/actions/workflows/ci.yml) ![GitHub release (latest SemVer)](https://img.shields.io/github/release/crossplane/function-sdk-python)
[![CI](https://github.com/crossplane/function-sdk-python/actions/workflows/ci.yml/badge.svg)](https://github.com/crossplane/function-sdk-python/actions/workflows/ci.yml)
![GitHub release (latest SemVer)](https://img.shields.io/github/release/crossplane/function-sdk-python) ![PyPI - Version](https://img.shields.io/pypi/v/crossplane-function-sdk-python)
The [Python][python] SDK for writing [composition functions][functions].
@ -18,6 +20,9 @@ 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
@ -42,5 +47,6 @@ hatch build
[python]: https://python.org
[functions]: https://docs.crossplane.io/latest/concepts/composition-functions
[python-protobuf]: https://protobuf.dev/reference/python/python-generated/
[function-template-python]: https://github.com/crossplane/function-template-python
[contributing guidelines]: https://github.com/crossplane/crossplane/tree/master/contributing
[hatch]: https://github.com/pypa/hatch