Getting started with grpc python (unary and streaming) (#7)

Co-authored-by: Arvind Bright <[email protected]>

Author: XuanWang-Amos

README.md

@@ -22,6 +22,8 @@ Here is a list of available codelabs in this repository:
 - [Getting Started with gRPC-Go (Streaming)](codelabs/Getting_Started_with_gRPC_Go_Streaming)
 - [Getting Started with gRPC-Java](codelabs/Getting_Started_with_gRPC_Java)
 - [Getting Started with gRPC-Java (Streaming)](codelabs/Getting_Started_with_gRPC_Java_Streaming)
+- [Getting Started with gRPC-Python](codelabs/Getting_Started_with_gRPC_Python)
+- [Getting Started with gRPC-Python (Streaming)](codelabs/Getting_Started_with_gRPC_Python_streaming)
 - [Setup Basic gRPC OpenTelemetry Plugin in gRPC C++](codelabs/Setup_Basic_gRPC_OpenTelemetry_Plugin_in_gRPC_CPP)
 - [Setup Basic gRPC OpenTelemetry Plugin in gRPC-Python](codelabs/Setup_Basic_gRPC_OpenTelemetry_Plugin_in_gRPC_Python)
 - [Setup Basic gRPC OpenTelemetry Plugin in gRPC-Go](codelabs/Setup_Basic_gRPC_OpenTelemetry_Plugin_in_gRPC_Go/)

codelabs/Getting_Started_with_gRPC_Python/README.md

@@ -0,0 +1,24 @@
+# Getting Started with gRPC-Python
+
+Get hands-on with gRPC for Python in this interactive codelab! <!-- TODO(arvindbr8): Insert link once codelab is published. -->
+
+
+Perfect for Python developers new to gRPC, those seeking a refresher, or anyone building distributed systems. No prior gRPC experience needed! 
+
+#### Build a complete gRPC service from scratch, learning: 
+- Protocol Buffers (protobuf): Define service contracts & data.
+- gRPC Code Generation: Auto-generate Python code.
+- Client/Server Communication: Implement seamless interactions.
+
+#### You'll gain: 
+- A working gRPC service in Python.
+- Hands-on experience with Protocol Buffers and code generation.
+- Skills to design, build, & test gRPC clients and servers.
+- A strong foundation in gRPC for real-world projects.
+
+## How to use this directory
+
+- [start_here](start_here/) directory serves as a starting point for the
+codelab.
+- [completed](completed/) directory showcases the finished code, giving you a
+peak of how the final implementation should look like.

codelabs/Getting_Started_with_gRPC_Python/completed/protos/route_guide.proto

@@ -0,0 +1,53 @@
+// Copyright 2024 gRPC authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+option java_multiple_files = true;
+option java_package = "io.grpc.examples.routeguide";
+option java_outer_classname = "RouteGuideProto";
+option objc_class_prefix = "RTG";
+
+package routeguide;
+
+// Interface exported by the server.
+service RouteGuide {
+  // A simple RPC.
+  //
+  // Obtains the feature at a given position.
+  //
+  // A feature with an empty name is returned if there's no feature at the given
+  // position.
+  rpc GetFeature(Point) returns (Feature) {}
+}
+
+// Points are represented as latitude-longitude pairs in the E7 representation
+// (degrees multiplied by 10**7 and rounded to the nearest integer).
+// Latitudes should be in the range +/- 90 degrees and longitude should be in
+// the range +/- 180 degrees (inclusive).
+message Point {
+  int32 latitude = 1;
+  int32 longitude = 2;
+}
+
+// A feature names something at a given point.
+//
+// If a feature could not be named, the name is empty.
+message Feature {
+  // The name of the feature.
+  string name = 1;
+
+  // The point where the feature is detected.
+  Point location = 2;
+}

codelabs/Getting_Started_with_gRPC_Python/completed/route_guide_client.py

@@ -0,0 +1,47 @@
+# Copyright 2024 gRPC authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""The Python implementation of the gRPC route guide client."""
+
+import logging
+
+import grpc
+import route_guide_pb2
+import route_guide_pb2_grpc
+
+def format_point(point):
+    # not delegating in point.__str__ because it is an empty string when its
+    # values are zero. In addition, it puts a newline between the fields.
+    return "latitude: %d, longitude: %d" % (point.latitude, point.longitude)
+
+def run():
+    point = route_guide_pb2.Point(latitude=409146138, longitude=-746188906)
+    channel = grpc.insecure_channel('localhost:50051')
+    stub = route_guide_pb2_grpc.RouteGuideStub(channel)
+    feature = stub.GetFeature(point)
+    if not feature.location:
+        print("Server returned incomplete feature")
+        return
+
+    if feature.name:
+        print(
+            "Feature called %r at %s"
+            % (feature.name, format_point(feature.location))
+        )
+    else:
+        print("Found no feature at %s" % format_point(feature.location))
+    channel.close()
+
+if __name__ == "__main__":
+    logging.basicConfig()
+    run()