chore: better separation of example usage in nextgen workspace

src/cdf/nextgen/workspace.py

@@ -87,51 +87,53 @@ def add_dependency(self, name: DependencyKey, definition: Dependency) -> None:
         self.injector.add_definition(name, definition)
 
 
-class DataTeamWorkspace(Workspace):
-    name = "data-team"
-    version = "0.1.1"
-
-    def get_services(self):
-        return {
-            "a": Dependency(1),
-            "b": Dependency(lambda a: a + 1),
-            "prod_bigquery": Dependency("dwh-123"),
-            "sfdc": Dependency(
-                ConfigResolver.map_section("sfdc")(
-                    lambda username: f"https://sfdc.com/{username}"
-                )
-            ),
-        }
-
-    def get_config_sources(self):
-        return [
-            {
-                "sfdc": {"username": "abc"},
-                "bigquery": {"project_id": ...},
-            },
-            *super().get_config_sources(),
-        ]
-
-
-datateam = DataTeamWorkspace()
-
-
-@ConfigResolver.map_values(b="a.b.c")
-def c(b: int) -> int:
-    return b * 10
-
-
-datateam.add_dependency("c", Dependency(c))
-
-
-def source_a(a: int, prod_bigquery: str):
-    print(f"Source A: {a=}, {prod_bigquery=}")
-
-
-print(datateam.injector(source_a))
-print(datateam.name)
-print(datateam.config_resolver["sfdc.username"])
-
-print(datateam.injector.get_or_raise("sfdc"))
-
-datateam.cli()
+if __name__ == "__main__":
+    # Example usage
+
+    # Define a workspace
+    class DataTeamWorkspace(Workspace):
+        name = "data-team"
+        version = "0.1.1"
+
+        def get_services(self):
+            return {
+                "a": Dependency(1),
+                "b": Dependency(lambda a: a + 1),
+                "prod_bigquery": Dependency("dwh-123"),
+                "sfdc": Dependency(
+                    ConfigResolver.map_section("sfdc")(
+                        lambda username: f"https://sfdc.com/{username}"
+                    )
+                ),
+            }
+
+        def get_config_sources(self):
+            return [
+                {
+                    "sfdc": {"username": "abc"},
+                    "bigquery": {"project_id": ...},
+                },
+                *super().get_config_sources(),
+            ]
+
+    # Create an instance of the workspace
+    datateam = DataTeamWorkspace()
+
+    @ConfigResolver.map_values(b="a.b.c")
+    def c(b: int) -> int:
+        return b * 10
+
+    # Imperatively add dependencies
+    datateam.add_dependency("c", Dependency(c))
+
+    def source_a(a: int, prod_bigquery: str):
+        print(f"Source A: {a=}, {prod_bigquery=}")
+
+    # Some interface examples
+    print(datateam.injector(source_a))
+    print(datateam.name)
+    print(datateam.config_resolver["sfdc.username"])
+    print(datateam.injector.get_or_raise("sfdc"))
+
+    # Run the autogenerated CLI
+    datateam.cli()