Improve python sdk (#197)

Signed-off-by: Zike Yang <[email protected]>

Author: RobertIndie

sdks/fs-python/Makefile

@@ -4,4 +4,4 @@ build-image:
 	docker build -t functionstream/fs-python-base .
 
 test:
-	pytest -v
+	PYTHONPATH=. python -m pytest

sdks/fs-python/README.md

@@ -16,31 +16,31 @@
 
 # FunctionStream Python SDK
 
-FunctionStream SDK is a powerful Python library for building and deploying serverless functions that process messages from Apache Pulsar. It provides a simple yet flexible framework for creating event-driven applications with robust error handling, metrics collection, and resource management.
+FunctionStream SDK is a powerful Python library for building and deploying serverless functions that process messages
+from Apache Pulsar. It provides a simple yet flexible framework for creating event-driven applications with robust error
+handling, metrics collection, and resource management.
 
 ## Features
 
 - **Easy Function Development**: Simple API for creating serverless functions
 - **Message Processing**: Built-in support for Apache Pulsar message processing
 - **Metrics Collection**: Automatic collection of performance metrics
 - **Resource Management**: Efficient handling of connections and resources
-- **Graceful Shutdown**: Proper cleanup of resources during shutdown
 - **Configuration Management**: Flexible configuration through YAML files
-- **Schema Validation**: Input and output schema validation
 - **Error Handling**: Comprehensive error handling and logging
 
 ## Installation
 
 ```bash
-pip install fs-sdk
+pip install function-stream
 ```
 
 ## Quick Start
 
 1. Create a function that processes messages:
 
 ```python
-from fs_sdk import FSFunction
+from function_stream import FSFunction
 
 async def my_process_function(request_data: dict) -> dict:
     # Process the request data
@@ -105,6 +105,7 @@ modules:
 ### FSFunction
 
 The main class for creating serverless functions. It handles:
+
 - Message consumption and processing
 - Response generation
 - Resource management
@@ -114,6 +115,7 @@ The main class for creating serverless functions. It handles:
 ### Configuration
 
 The SDK uses YAML configuration files to define:
+
 - Pulsar connection settings
 - Module selection
 - Topic subscriptions
@@ -123,6 +125,7 @@ The SDK uses YAML configuration files to define:
 ### Metrics
 
 Built-in metrics collection for:
+
 - Request processing time
 - Success/failure rates
 - Message throughput
@@ -140,24 +143,24 @@ Check out the `examples` directory for complete examples:
 ## Best Practices
 
 1. **Error Handling**
-   - Always handle exceptions in your process functions
-   - Use proper logging for debugging
-   - Implement graceful shutdown
+    - Always handle exceptions in your process functions
+    - Use proper logging for debugging
+    - Implement graceful shutdown
 
 2. **Resource Management**
-   - Close resources properly
-   - Use context managers when possible
-   - Monitor resource usage
+    - Close resources properly
+    - Use context managers when possible
+    - Monitor resource usage
 
 3. **Configuration**
-   - Use environment variables for sensitive data
-   - Validate configuration values
-   - Document configuration options
+    - Use environment variables for sensitive data
+    - Validate configuration values
+    - Document configuration options
 
 4. **Testing**
-   - Write unit tests for your functions
-   - Test error scenarios
-   - Validate input/output schemas
+    - Write unit tests for your functions
+    - Test error scenarios
+    - Validate input/output schemas
 
 ## Development
 
@@ -180,13 +183,13 @@ source venv/bin/activate  # Linux/Mac
 pip install -r requirements.txt
 
 # Install the package in development mode
-pip install -e .
+python -m pip install -e .
 ```
 
 ### Running Tests
 
 ```bash
-pytest
+make test
 ```
 
 ## Support

sdks/fs-python/examples/Dockerfile

@@ -5,8 +5,8 @@ WORKDIR /function
 COPY requirements.txt .
 RUN pip install -r requirements.txt
 
-COPY string_function.py .
-COPY config.yaml .
-COPY package.yaml .
+COPY main.py .
 
-CMD ["python", "string_function.py"] 
+RUN chmod +x main.py
+
+CMD ["python", "main.py"]

sdks/fs-python/examples/config.yaml

@@ -16,7 +16,7 @@
 # This configuration file defines the settings for the string processing function example.
 
 pulsar:
-  serviceUrl: "pulsar://192.168.31.80:6650"  # Required: URL of the Pulsar broker
+  serviceUrl: "pulsar://127.0.0.1:6650"  # Required: URL of the Pulsar broker
   authPlugin: ""  # Optional: Authentication plugin class name
   authParams: ""  # Optional: Authentication parameters
 

…ks/fs-python/examples/string_function.py sdks/fs-python/examples/main.pysdks/fs-python/examples/string_function.py renamed to sdks/fs-python/examples/main.py sdks/fs-python/examples/string_function.py renamed to sdks/fs-python/examples/main.py

@@ -20,8 +20,7 @@
 import asyncio
 from typing import Dict, Any
 
-from fs_sdk import FSFunction
-from fs_sdk.context import FSContext
+from function_stream import FSFunction, FSContext
 
 async def string_process_function(context: FSContext, data: Dict[str, Any]) -> Dict[str, Any]:
     """

sdks/fs-python/examples/test_string_function.py

@@ -20,7 +20,6 @@
 import pulsar
 import json
 import uuid
-import time
 
 async def test_string_function():
     """

sdks/fs-python/fs_sdk/__init__.py

@@ -0,0 +1,27 @@
+from .config import Config, PulsarConfig, PulsarSourceConfig, SourceSpec, SinkSpec, Metric
+from .context import FSContext
+from .function import FSFunction
+from .metrics import Metrics, MetricsServer
+from .module import FSModule
+
+__version__ = "0.6.0rc1"
+__all__ = [
+    # Core classes
+    "FSFunction",
+    "FSModule",
+
+    # Configuration classes
+    "Config",
+    "PulsarConfig",
+    "PulsarSourceConfig",
+    "SourceSpec",
+    "SinkSpec",
+    "Metric",
+
+    # Context and utilities
+    "FSContext",
+
+    # Metrics and monitoring
+    "Metrics",
+    "MetricsServer"
+]