Add gRPC interface generation using grpcio-tools (#7)

Author: timl3136

README.md

@@ -54,36 +54,71 @@ cd cadence-python-client
    pip install -e ".[dev]"
    ```
 
-### Generate Protobuf Files
+### Generate Protobuf and gRPC Files
 
 Run the generation script:
 ```bash
+# Using uv (recommended)
+uv run python scripts/generate_proto.py
+
+# Or using traditional Python
 python scripts/generate_proto.py
 ```
 
 This will:
 - Download protoc 29.1 binary
-- Generate Python files in `cadence/api/v1/`
-- Create proper package structure
+- Install grpcio-tools if needed
+- Generate Python protobuf files in `cadence/api/v1/`
+- Generate gRPC service files in `cadence/api/v1/`
+- Create proper package structure with both protobuf and gRPC imports
 
 ### Test
 
 Verify the generated files work:
 ```bash
+# Using uv (recommended)
+uv run python cadence/sample/simple_usage_example.py
+uv run python cadence/sample/grpc_usage_example.py
+
+# Or using traditional Python
 python cadence/sample/simple_usage_example.py
+python test_grpc_with_examples.py
 ```
 
-### Usage
+### Development Script
+
+The project includes a development script that provides convenient commands for common tasks:
+
+```bash
+# Generate protobuf files
+uv run python scripts/dev.py protobuf
+
+# Run tests
+uv run python scripts/dev.py test
+
+# Run tests with coverage
+uv run python scripts/dev.py test-cov
+
+# Run linting
+uv run python scripts/dev.py lint
+
+# Format code
+uv run python scripts/dev.py format
+
+# Install in development mode
+uv run python scripts/dev.py install
+
+# Install with dev dependencies
+uv run python scripts/dev.py install-dev
 
-```python
-from cadence.api.v1 import workflow, common, domain
+# Build package
+uv run python scripts/dev.py build
 
-# Create objects
-wf_exec = common.WorkflowExecution()
-wf_exec.workflow_id = "my-workflow"
+# Clean build artifacts
+uv run python scripts/dev.py clean
 
-# Use enums
-status = workflow.WORKFLOW_EXECUTION_CLOSE_STATUS_COMPLETED
+# Run all checks (lint + test)
+uv run python scripts/dev.py check
 ```
 
 ## License

cadence/api/v1/__init__.py

@@ -1,5 +1,5 @@
 # Auto-generated __init__.py file
-# Import all generated protobuf modules
+# Import all generated protobuf and gRPC modules
 from . import common_pb2
 from . import decision_pb2
 from . import domain_pb2
@@ -14,6 +14,20 @@
 from . import tasklist_pb2
 from . import visibility_pb2
 from . import workflow_pb2
+from . import common_pb2_grpc
+from . import decision_pb2_grpc
+from . import domain_pb2_grpc
+from . import error_pb2_grpc
+from . import history_pb2_grpc
+from . import query_pb2_grpc
+from . import service_domain_pb2_grpc
+from . import service_meta_pb2_grpc
+from . import service_visibility_pb2_grpc
+from . import service_worker_pb2_grpc
+from . import service_workflow_pb2_grpc
+from . import tasklist_pb2_grpc
+from . import visibility_pb2_grpc
+from . import workflow_pb2_grpc
 
 # Create cleaner aliases for easier imports
 common = common_pb2
@@ -30,8 +44,22 @@
 tasklist = tasklist_pb2
 visibility = visibility_pb2
 workflow = workflow_pb2
+common_grpc = common_pb2_grpc
+decision_grpc = decision_pb2_grpc
+domain_grpc = domain_pb2_grpc
+error_grpc = error_pb2_grpc
+history_grpc = history_pb2_grpc
+query_grpc = query_pb2_grpc
+service_domain_grpc = service_domain_pb2_grpc
+service_meta_grpc = service_meta_pb2_grpc
+service_visibility_grpc = service_visibility_pb2_grpc
+service_worker_grpc = service_worker_pb2_grpc
+service_workflow_grpc = service_workflow_pb2_grpc
+tasklist_grpc = tasklist_pb2_grpc
+visibility_grpc = visibility_pb2_grpc
+workflow_grpc = workflow_pb2_grpc
 
-# Only expose clean module names (no _pb2)
+# Only expose clean module names
 __all__ = [
     'common',
     'decision',
@@ -47,4 +75,18 @@
     'tasklist',
     'visibility',
     'workflow',
+    'common_grpc',
+    'decision_grpc',
+    'domain_grpc',
+    'error_grpc',
+    'history_grpc',
+    'query_grpc',
+    'service_domain_grpc',
+    'service_meta_grpc',
+    'service_visibility_grpc',
+    'service_worker_grpc',
+    'service_workflow_grpc',
+    'tasklist_grpc',
+    'visibility_grpc',
+    'workflow_grpc',
 ]

cadence/api/v1/common_pb2_grpc.py

@@ -0,0 +1,24 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+
+GRPC_GENERATED_VERSION = '1.71.2'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + f' but the generated code in cadence/api/v1/common_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )

cadence/api/v1/decision_pb2_grpc.py

@@ -0,0 +1,24 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+
+GRPC_GENERATED_VERSION = '1.71.2'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + f' but the generated code in cadence/api/v1/decision_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )

cadence/api/v1/domain_pb2_grpc.py

@@ -0,0 +1,24 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+
+GRPC_GENERATED_VERSION = '1.71.2'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + f' but the generated code in cadence/api/v1/domain_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )

cadence/api/v1/error_pb2_grpc.py

@@ -0,0 +1,24 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+
+GRPC_GENERATED_VERSION = '1.71.2'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + f' but the generated code in cadence/api/v1/error_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )

cadence/api/v1/history_pb2_grpc.py

@@ -0,0 +1,24 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+
+GRPC_GENERATED_VERSION = '1.71.2'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + f' but the generated code in cadence/api/v1/history_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )

cadence/api/v1/query_pb2_grpc.py

@@ -0,0 +1,24 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+
+GRPC_GENERATED_VERSION = '1.71.2'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + f' but the generated code in cadence/api/v1/query_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )