Zyp: Export main symbols via zyp namespace

crate · Sep 22, 2024 · 518110a · 518110a
1 parent aeea33c
commit 518110a
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 10 deletions.
diff --git a/doc/zyp/examples.md b/doc/zyp/examples.md
@@ -62,7 +62,7 @@ no tutorial yet: Please look at the source and software tests.
 # Includes column renaming and applying Python converter functions.
 
 from pprint import pprint
-from zyp.model.bucket import BucketTransformation, FieldRenamer, ValueConverter
+from zyp import BucketTransformation, FieldRenamer, ValueConverter
 
 # Consider a slightly messy collection of records.
 data_in = [
@@ -191,9 +191,9 @@ no tutorial yet: Please look at the source and software tests.
 # Uses all of JMES, jq, and JSON Pointer technologies for demonstration purposes.
 
 from pprint import pprint
-from zyp.model.bucket import BucketTransformation, FieldRenamer, ValueConverter
-from zyp.model.collection import CollectionTransformation
-from zyp.model.moksha import MokshaTransformation
+from zyp import \
+  BucketTransformation, CollectionTransformation, \
+  FieldRenamer, MokshaTransformation, ValueConverter
 
 # Consider a slightly messy collection of records.
 data_in = {
@@ -322,8 +322,7 @@ no tutorial yet: Please look at the source and software tests.
 # Includes a Moksha/jq transformation rule for including elements.
 
 from pprint import pprint
-from zyp.model.collection import CollectionTransformation
-from zyp.model.moksha import MokshaTransformation
+from zyp import CollectionTransformation, MokshaTransformation
 
 data_in = [
     {
@@ -413,8 +412,7 @@ no tutorial yet: Please look at the source and software tests.
 # Includes a Moksha/jq transformation rule for excluding elements.
 
 from pprint import pprint
-from zyp.model.collection import CollectionTransformation
-from zyp.model.moksha import MokshaTransformation
+from zyp import CollectionTransformation, MokshaTransformation
 
 data_in = [
     {
@@ -504,8 +502,7 @@ no tutorial yet: Please look at the source and software tests.
 # Includes two Moksha/jq transformation rules for unwrapping and flattening.
 
 from pprint import pprint
-from zyp.model.collection import CollectionTransformation
-from zyp.model.moksha import MokshaTransformation
+from zyp import CollectionTransformation, MokshaTransformation
 
 data_in = {
     "message-source": "community",

diff --git a/src/zyp/__init__.py b/src/zyp/__init__.py
@@ -0,0 +1,17 @@
+from zyp.model import (
+    BucketTransformation,
+    CollectionTransformation,
+    FieldRenamer,
+    MokshaTransformation,
+    TransonTransformation,
+    ValueConverter,
+)
+
+__all__ = [
+    "CollectionTransformation",
+    "BucketTransformation",
+    "FieldRenamer",
+    "MokshaTransformation",
+    "TransonTransformation",
+    "ValueConverter",
+]
diff --git a/src/zyp/model/__init__.py b/src/zyp/model/__init__.py
@@ -0,0 +1,12 @@
+from zyp.model.bucket import BucketTransformation, FieldRenamer, TransonTransformation, ValueConverter
+from zyp.model.collection import CollectionTransformation
+from zyp.model.moksha import MokshaTransformation
+
+__all__ = [
+    "CollectionTransformation",
+    "BucketTransformation",
+    "FieldRenamer",
+    "MokshaTransformation",
+    "TransonTransformation",
+    "ValueConverter",
+]