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 to the protobuf generated code guide 

Signed-off-by: Nic Cope <nicc@rk0n.org>
This commit is contained in:
Nic Cope 2023-11-19 13:44:37 -08:00
parent e247d8766e
commit 7bb33ae97f
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -10,6 +10,13 @@ guidelines] as Crossplane.
To learn how to use this SDK: To learn how to use this SDK:
* [Learn about how composition functions work][functions] * [Learn about how composition functions work][functions]
* [Learn about Python code generated from protocol buffers][python-protobuf]
The `RunFunctionRequest` and `RunFunctionResponse` types provided by this SDK
are generated from a proto3 protocol buffer schema. Their fields behave
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.
## Contributing ## Contributing
@ -35,5 +42,6 @@ hatch build
[python]: https://python.org [python]: https://python.org
[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/
[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