feat: add common utils

docs/conf.py

@@ -56,8 +56,45 @@
 nitpicky = True
 
 nitpick_ignore = [
+    ("py:class", "_PDT"),  # private type annotations
+    ("py:class", "_RDT"),  # private type annotations
+    ("py:class", "Processor"),  # docs aren't published yet
+    ("py:class", "Sink"),  # docs aren't published yet
+    ("py:class", "Source"),  # docs aren't published yet
+    ("py:class", "TracebackType"),  # Used as type annotation. Only available when type checking
+    ("py:class", "WorkflowDefinition"),  # docs aren't published yet
+    ("py:class", "concurrent.futures._base.Executor"),  # sphinx can't find it
     ("py:class", "concurrent.futures._base.Future"),  # sphinx can't find it
+    ("py:class", "sghi.etl.commons.processors._PDT"),  # private type annotations
+    ("py:class", "sghi.etl.commons.processors._RDT"),  # private type annotations
+    ("py:class", "sghi.etl.commons.sinks._PDT"),  # private type annotations
+    ("py:class", "sghi.etl.commons.sinks._RDT"),  # private type annotations
+    ("py:class", "sghi.etl.commons.sources._PDT"),  # private type annotations
+    ("py:class", "sghi.etl.commons.sources._RDT"),  # private type annotations
     ("py:class", "sghi.etl.commons.utils.result_gatherers._T"),  # private type annotations
+    ("py:class", "sghi.etl.commons.workflow_builder._PDT"),  # private type annotations
+    ("py:class", "sghi.etl.commons.workflow_builder._RDT"),  # private type annotations
+    ("py:class", "sghi.etl.commons.workflow_definition._PDT"),  # private type annotations
+    ("py:class", "sghi.etl.commons.workflow_definition._RDT"),  # private type annotations
+    ("py:class", "sghi.etl.core._RDT"),  # private type annotations
+    ("py:class", "sghi.etl.core._PDT"),  # private type annotations
+    ("py:class", "sghi.etl.core.Processor"),  # docs aren't published yet
+    ("py:class", "sghi.etl.core.Sink"),  # docs aren't published yet
+    ("py:class", "sghi.etl.core.Source"),  # docs aren't published yet
+    ("py:class", "sghi.etl.core.WorkflowDefinition"),  # docs aren't published yet
+    ("py:class", "sghi.retry.Retry"),  # docs aren't published yet
+    ("py:exc", "sghi.disposable.ResourceDisposedError"),  # docs aren't published yet
+    ("py:func", "sghi.disposable.not_disposed"),  # docs aren't published yet
+    ("py:obj", "sghi.etl.commons.processors._PDT"),  # private type annotations
+    ("py:obj", "sghi.etl.commons.processors._RDT"),  # private type annotations
+    ("py:obj", "sghi.etl.commons.sinks._PDT"),  # private type annotations
+    ("py:obj", "sghi.etl.commons.sinks._RDT"),  # private type annotations
+    ("py:obj", "sghi.etl.commons.sources._PDT"),  # private type annotations
+    ("py:obj", "sghi.etl.commons.sources._RDT"),  # private type annotations
+    ("py:obj", "sghi.etl.commons.workflow_builder._PDT"),  # private type annotations
+    ("py:obj", "sghi.etl.commons.workflow_builder._RDT"),  # private type annotations
+    ("py:obj", "sghi.etl.commons.workflow_definition._PDT"),  # private type annotations
+    ("py:obj", "sghi.etl.commons.workflow_definition._RDT"),  # private type annotations
 ]
 
 templates_path = ["templates"]

src/sghi/etl/commons/__init__.py

@@ -1 +1,27 @@
 """Collection of utilities for working with SGHI ETL Worflows."""
+
+from .processors import (
+    NoOpProcessor,
+    ProcessorPipe,
+    ProcessorSet,
+    ScatterProcessor,
+    processor,
+)
+from .sinks import NullSink, ScatterSink, SinkSet, sink
+from .sources import SourceSet, source
+from .workflow_builder import WorkflowBuilder
+
+__all__ = [
+    "NoOpProcessor",
+    "NullSink",
+    "ProcessorPipe",
+    "ProcessorSet",
+    "ScatterProcessor",
+    "ScatterSink",
+    "SinkSet",
+    "SourceSet",
+    "WorkflowBuilder",
+    "processor",
+    "sink",
+    "source",
+]