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

Link guide, package docs 

Signed-off-by: Nic Cope <nicc@rk0n.org>
This commit is contained in:
Nic Cope 2024-01-12 16:03:26 -08:00
parent fd28b20cb7
commit 73cfd7dc91
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -10,14 +10,15 @@ guidelines] as Crossplane.
To learn how to use this SDK: To learn how to use this SDK:
* [Follow the guide to writing a composition function in Python][function guide]
* [Learn about how composition functions work][functions] * [Learn about how composition functions work][functions]
* [Learn about Python code generated from protocol buffers][python-protobuf] * [Read the package documentation][package docs]
The `RunFunctionRequest` and `RunFunctionResponse` types provided by this SDK The `RunFunctionRequest` and `RunFunctionResponse` types provided by this SDK
are generated from a proto3 protocol buffer schema. Their fields behave are generated from a proto3 protocol buffer schema. Their fields behave
similarly to built-in Python types like lists and dictionaries, but there are similarly to built-in Python types like lists and dictionaries, but there are
some differences. Read the generated code documentation to familiarize yourself some differences. Read the [generated code documentation][python-protobuf] to
with the the differences. familiarize yourself with the the differences.
If you just want to jump in and get started, consider using the If you just want to jump in and get started, consider using the
[function-template-python] template repository. [function-template-python] template repository.
@ -47,5 +48,7 @@ hatch build
[functions]: https://docs.crossplane.io/latest/concepts/composition-functions [functions]: https://docs.crossplane.io/latest/concepts/composition-functions
[python-protobuf]: https://protobuf.dev/reference/python/python-generated/ [python-protobuf]: https://protobuf.dev/reference/python/python-generated/
[function-template-python]: https://github.com/crossplane/function-template-python [function-template-python]: https://github.com/crossplane/function-template-python
[function guide]: https://docs.crossplane.io/knowledge-base/guides/write-a-composition-function-in-python
[package docs]: https://crossplane.github.io/function-sdk-python
[contributing guidelines]: https://github.com/crossplane/crossplane/tree/master/contributing [contributing guidelines]: https://github.com/crossplane/crossplane/tree/master/contributing
[hatch]: https://github.com/pypa/hatch [hatch]: https://github.com/pypa/hatch