junban 1.0.0__py3-none-any.whl

junban/__init__.py

@@ -0,0 +1,5 @@
+from .pipeline import Pipeline
+from .pipeline_step import PipelineStep
+from .pipeline_context import PipelineContext
+
+__all__ = ["PipelineStep", "PipelineContext", "Pipeline"]

junban/pipeline.py

@@ -0,0 +1,53 @@
+import logging
+
+from typing import List, Generic, Optional
+
+from .pipeline_context import C
+from .pipeline_step import PipelineStep
+
+
+class Pipeline(Generic[C]):
+    def __init__(self, steps: List[PipelineStep[C]], name: Optional[str] = "PIPELINE",
+                 logger: Optional[logging.Logger] = None):
+        """
+        Main junban pipeline class.
+
+        :param steps: Pipeline steps to be executed.
+        :param name: Name of the pipeline, defaults to "PIPELINE".
+        :param logger: Optional logger to log pipeline steps, defaults to None.
+        If no logger is provided, logs will be printed to stdout.
+        """
+        self.steps: List[PipelineStep[C]] = steps
+        self.name = name
+        self._log_info = lambda msg: self._log_info_func(msg, logger)
+        self._log_error = lambda msg: self._log_error_func(msg, logger)
+
+    @staticmethod
+    def _log_info_func(message: str, logger: logging.Logger = None):
+        if logger is None:
+            print(message)
+        else:
+            logger.info(message)
+
+    @staticmethod
+    def _log_error_func(message: str, logger: logging.Logger = None):
+        if logger is None:
+            print(message)
+        else:
+            logger.error(message)
+
+    def execute(self, context: C) -> C:
+        """ Run the pipeline steps with the given initial context."""
+        current_context = context
+        for step in self.steps:
+            try:
+                self._log_info(f"[{self.name}] {step.get_start_message()}")
+                current_context = step.run(current_context)
+                self._log_info(f"[{self.name}] {step.get_end_message()}")
+            except AssertionError as e:
+                self._log_error(f"[{self.name}] Assertion error in step {step.__class__.__name__}: {str(e)}")
+                raise
+            except Exception as e:
+                self._log_error(f"[{self.name}] Error in step {step.__class__.__name__}: {str(e)}")
+                raise
+        return current_context

junban/pipeline_context.py

@@ -0,0 +1,7 @@
+from typing import TypeVar
+
+class PipelineContext:
+    """ Large struct to hold pipeline context during execution """
+    pass
+
+C = TypeVar("C", bound=PipelineContext)

junban/pipeline_step.py

@@ -0,0 +1,44 @@
+from typing import Generic
+from abc import ABC, abstractmethod
+
+from .pipeline_context import C
+
+
+class PipelineStep(ABC, Generic[C]):
+
+    @abstractmethod
+    def _check_entry_assumptions(self, context: C) -> bool:
+        """ You can use this method to check if the pipeline step can be executed.
+        Depending on your use case, you can use assert statements, raise exceptions, or return a boolean.
+        """
+        return True
+
+    @abstractmethod
+    def _check_exit_assumptions(self, context: C) -> bool:
+        """ You can use this method to check if the pipeline step executed successfully.
+        Depending on your use case, you can use assert statements, raise exceptions, or return a boolean.
+        """
+        return True
+
+    @abstractmethod
+    def get_start_message(self) -> str:
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_end_message(self) -> str:
+        raise NotImplementedError
+
+    @abstractmethod
+    def _execute(self, context: C) -> C:
+        raise NotImplementedError
+
+    def run(self, context: C) -> C:
+        if not self._check_entry_assumptions(context):
+            assert False, "Entry assumptions not met"
+
+        context = self._execute(context)
+
+        if not self._check_exit_assumptions(context):
+            assert False, "Exit assumptions not met"
+
+        return context

junban-1.0.0.dist-info/METADATA

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: junban
+Version: 1.0.0
+Summary: Junban – Simple Sequential Python Workflows
+Requires-Python: >=3.11
+License-File: LICENSE
+Dynamic: license-file

junban-1.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+junban/__init__.py,sha256=H1IsqTUJoaO_KZ08u2HFtBYxced9Klq79dbSxwVcROQ,176
+junban/pipeline.py,sha256=xB6CeFFQ9a9rqwqlrNK1YJfaxR8RwEG-vEDo3hqOTWg,1996
+junban/pipeline_context.py,sha256=z_UejwGxjEMrD_Fe5VJ2KGWgp7CcOObHy07zT1yXNf0,168
+junban/pipeline_step.py,sha256=th7ui4mXaXvAMmQsL1O9Lrg9RA1DDbkSnB6fwgKIIVg,1348
+junban-1.0.0.dist-info/licenses/LICENSE,sha256=zJ6mT-z4aLQS5xpN3OcdyKehHd2Xc_xFVqHErj8bexs,1067
+junban-1.0.0.dist-info/METADATA,sha256=J0l5iYfC6qgGEY1-R1FAMtIxFyB3j1ytrV3RXEaSdcc,173
+junban-1.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+junban-1.0.0.dist-info/top_level.txt,sha256=ZRqoSNgloxnaqyPEFEPg5ZRPc14W5yQ6uV33CZHJnSc,7
+junban-1.0.0.dist-info/RECORD,,

junban-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

junban-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 biocentral
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

junban-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+junban