feat: enhance Python SDK with metadata support and improve doc #205
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
This PR addresses several areas of improvement in the FunctionStream project:
Namespace Consistency: Updates example configuration files to use the more descriptive
function-streamnamespace instead of the abbreviatedfsnamespace, improving clarity and consistency across the project.Python SDK Enhancement: Significantly enhances the Python SDK (
fs-python) with new metadata access capabilities, improved documentation, and better error handling for message processing.Operator Improvements: Adds code generation capabilities to the operator Makefile for generating client SDKs, improving the development workflow.
Docker Build Enhancement: Adds multi-platform Docker build support for the Python SDK base image.
Modifications
Configuration Updates
functions/example-external.yamlandfunctions/example-functions.yamlto usefunction-streamnamespace and subscription names instead offsIfNotPresenttoAlwaysinoperator/deploy/chart/values.yamlPython SDK Enhancements
0.6.0rc1to0.6.0rc2get_metadata()method toFSContextclass for accessing message metadata (topic, message_id)produce()method toFSContextfor output stream data productionOperator Improvements
code-generatortarget to operator Makefile with versionv0.32.1generate-clienttarget for generating Kubernetes client SDKs using code-generator toolsDocker Build Enhancement
docker-buildxtarget in Python SDK Makefile for building images for bothlinux/amd64andlinux/arm64architecturesTesting Improvements
These changes improve the overall developer experience, provide better functionality for Python SDK users, and establish more consistent naming conventions across the project.