update readme

Author: Fraser-Isbester

README.md

@@ -17,7 +17,7 @@ This template generates basic Python Dataclasses from Proto Messages.
 // A proto file for the Widget service
 syntax = "proto3";
 
-package simple_types.v1.widget;
+package simple_types.v1 ;
 
 // The Widget type defines a Widget object
 message Widget {
@@ -31,19 +31,31 @@ message Widget {
     repeated string colors = 4;
     // global stock by color
     map<string, int32> stock_by_color = 5;
+    // The number of widgets in stock at various locations
+    map<int32, WidgetFactory> stock_by_warehouse = 6;
 
     // The Size enum defines the size of the widget
     enum Size {
         // The Widget Size is unknown
-        UNKNOWN = 0;
+        SIZE_UNSPECIFIED = 0;
         // The Widget Size is small
-        SMALL = 1;
+        SIZE_SMALL = 1;
         // The Widget Size is medium
-        MEDIUM = 2;
+        SIZE_MEDIUM = 2;
         // The Widget Size is large
-        LARGE = 3;
+        SIZE_LARGE = 3;
     }
 }
+
+// Describes a Widget Factory
+message WidgetFactory {
+	// The id of the factory
+	int32 id = 1 ;
+	// The name of the factory
+	string name = 2 ;
+	// The address of the factory
+	string address = 3 ;
+}
 ```
 </details>
 
@@ -65,34 +77,63 @@ class Widget:
     r"""The Widget type defines a Widget object"""
 
     # The fixed set of attrbiutes for the Widget Type.
-    __slots__ = ("name", "size", "created", "colors", "stock_by_color")
-
-    # The name of the widget
-    name: "str"
-
-    # The size of the widget
+    __slots__ = (
+        "name",
+        "size",
+        "created",
+        "colors",
+        "stock_by_color",
+        "stock_by_warehouse",
+    )
+
+    # The name of the widget.
+    name: str
+
+    # The size of the widget.
     size: "Size"
 
-    # The date the widget was created
-    created: "int"
+    # The date the widget was created.
+    created: int
+
+    # The colors available for the widget.
+    colors: Tuple[str] = dataclasses.field(default_factory=Tuple)
 
-    # The colors available for the widget
-    colors: "Tuple[str]" = dataclasses.field(default_factory=Tuple)
+    # global stock by color.
+    stock_by_color: OrderedDict[str, int] = dataclasses.field(default_factory=Tuple)
 
-    # global stock by color
-    stock_by_color: "OrderedDict[str, int]" = dataclasses.field(default_factory=Tuple)
+    # The number of widgets in stock at various locations.
+    stock_by_warehouse: OrderedDict[int, "WidgetFactory"] = dataclasses.field(
+        default_factory=Tuple
+    )
 
     class Size(Enum):
         r"""The Size enum defines the size of the widget"""
 
         # The Widget Size is unknown
-        UNKNOWN = 0
+        SIZE_UNSPECIFIED = 0
         # The Widget Size is small
-        SMALL = 1
+        SIZE_SMALL = 1
         # The Widget Size is medium
-        MEDIUM = 2
+        SIZE_MEDIUM = 2
         # The Widget Size is large
-        LARGE = 3
+        SIZE_LARGE = 3
+
+
+@dataclasses.dataclasses
+class WidgetFactory:
+    r"""Describes a Widget Factory"""
+
+    # The fixed set of attrbiutes for the WidgetFactory Type.
+    __slots__ = ("id", "name", "address")
+
+    # The id of the factory.
+    id: int
+
+    # The name of the factory.
+    name: str
+
+    # The address of the factory.
+    address: str
 
 ```
 </details>