Add Python Tour of Restate

.github/workflows/pre-release.yml

@@ -11,6 +11,10 @@ on:
         description: "sdk-typescript version (without prepending v)."
         required: false
         type: string
+      sdkPythonVersion:
+        description: "sdk-python version (without prepending v)."
+        required: false
+        type: string
       sdkJavaVersion:
         description: "sdk-java version (without prepending v)."
         required: false
@@ -85,6 +89,14 @@ jobs:
           field: TYPESCRIPT_SDK_VERSION
           value: ${{ inputs.sdkTypescriptVersion }}
 
+      - name: Update restate.config.json with new Python sdk version
+        uses: jossef/[email protected]
+        if: ${{ inputs.sdkPythonVersion != '' }}
+        with:
+          file: restate.config.json
+          field: PYTHON_SDK_VERSION
+          value: ${{ inputs.sdkPythonVersion }}
+
       - name: Update restate.config.json with new Java sdk version
         uses: jossef/[email protected]
         if: ${{ inputs.sdkJavaVersion != '' }}
@@ -105,6 +117,26 @@ jobs:
       - name: Compile TypeScript code snippets
         run: npm install --prefix code_snippets/ts && npm run build --prefix code_snippets/ts
 
+      # Upgrade Python code snippets if new version is provided
+      - name: Upgrade Python Restate SDK
+        if: github.event.inputs.sdkPythonVersion != ''
+        run: sed -i 's/restate_sdk==[0-9A-Za-z.-]*/restate_sdk=="${{ inputs.sdkPythonVersion }}"/' "code_snippets/python/requirements.txt"
+
+      # Test if Python code snippets compile
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Install dependencies and check Python code snippets
+        run: |
+          cd code_snippets/python
+          python3 -m venv .venv
+          source .venv/bin/activate
+          pip install -r requirements.txt
+          pip install mypy
+          python3 -m mypy .
+          deactivate
+
       # Upgrade Java code snippets if new version is provided
       - name: Find and replace restateVersion in build.gradle.kts for Java code snippets
         if: ${{ inputs.sdkJavaVersion != '' }}

.github/workflows/test-build.yml

@@ -41,6 +41,24 @@ jobs:
           exit 1
           fi
 
+
+      # Setup Python
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      # Test if Python code snippets compile
+      - name: Install dependencies and check Python code snippets
+        run: |
+          cd code_snippets/python
+          python3 -m venv .venv
+          source .venv/bin/activate
+          pip install -r requirements.txt
+          pip install mypy
+          python3 -m mypy .
+          deactivate
+
       # Setup Java
       - uses: actions/setup-java@v3
         with:

.gitignore

@@ -23,3 +23,4 @@ yarn-error.log*
 .yarn
 /code_snippets/ts/node_modules/
 /code_snippets/ts/dist/
+/code_snippets/python/venv/

code_snippets/go/develop/awakeable.go

@@ -0,0 +1,49 @@
+package develop
+
+import (
+	"fmt"
+
+	restate "github.com/restatedev/sdk-go"
+)
+
+type Awakeable struct{}
+
+func (Awakeable) Greet(ctx restate.Context, name string) (restate.Void, error) {
+	// <start_here>
+	// <mark_1>
+	awakeable := restate.AwakeableAs[string](ctx)
+	awakeableId := awakeable.Id()
+	// </mark_1>
+
+	// <mark_2>
+	restate.RunAs(ctx, func(ctx restate.RunContext) (string, error) {
+		return triggerTaskAndDeliverId(awakeableId)
+	})
+	// </mark_2>
+
+	// <mark_3>
+	payload, err := awakeable.Result()
+	if err != nil {
+		return restate.Void{}, err
+	}
+	// </mark_3>
+	// <end_here>
+
+	_ = payload
+
+	// <start_resolve>
+	if err := ctx.ResolveAwakeable(awakeableId, "hello"); err != nil {
+		return restate.Void{}, err
+	}
+	// <end_resolve>
+
+	// <start_reject>
+	ctx.RejectAwakeable(awakeableId, fmt.Errorf("my error reason"))
+	// <end_reject>
+
+	return restate.Void{}, nil
+}
+
+func triggerTaskAndDeliverId(awakeableId string) (string, error) {
+	return "123", nil
+}

code_snippets/go/develop/codegen/codegen.go

@@ -0,0 +1,58 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"log"
+
+	"github.com/restatedev/documentation/code_snippets/go/develop/codegen/proto"
+	restate "github.com/restatedev/sdk-go"
+	"github.com/restatedev/sdk-go/server"
+)
+
+// <start_server>
+type greeter struct {
+	proto.UnimplementedGreeterServer
+}
+
+func (greeter) SayHello(ctx restate.Context, req *proto.HelloRequest) (*proto.HelloResponse, error) {
+	return &proto.HelloResponse{
+		Message: fmt.Sprintf("%s!", req.Name),
+	}, nil
+}
+
+func main() {
+	if err := server.NewRestate().
+		Bind(proto.NewGreeterServer(greeter{})).
+		Start(context.Background(), ":9080"); err != nil {
+		log.Fatal(err)
+	}
+}
+
+// <end_server>
+
+type GreeterClient struct{}
+
+func (GreeterClient) CallGreeter(ctx restate.Context, _ restate.Void) (restate.Void, error) {
+	// <start_client>
+	client := proto.NewGreeterClient(ctx)
+	resp, err := client.SayHello().Request(&proto.HelloRequest{Name: "world"})
+	if err != nil {
+		return restate.Void{}, err
+	}
+	// <end_client>
+	_ = resp
+
+	{
+		// <start_virtual_object_client>
+		client := proto.NewCounterClient(ctx, "key-1")
+		resp, err := client.Add().Request(&proto.AddRequest{Delta: 1})
+		if err != nil {
+			return restate.Void{}, err
+		}
+		// <end_virtual_object_client>
+		_ = resp
+	}
+
+	return restate.Void{}, nil
+}