junban 1.0.0__tar.gz → 1.0.2__tar.gz

junban-1.0.2/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: junban
+Version: 1.0.2
+Summary: Junban – Simple Sequential Python Workflows
+Author-email: Sebastian Franz <sebastian.franz@tum.de>
+Project-URL: Issues, https://github.com/biocentral/junban/issues
+Project-URL: Repository, https://github.com/biocentral/junban
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Junban (順番) – Simple Sequential Python Workflows
+
+Junban (english: order) is a lightweight library for defining and executing sequential (scientific) workflows in Python.
+
+## Installation
+
+Junban is available via [pypi](https://pypi.org/project/junban/):
+
+```shell
+pip install junban
+```
+
+## Quick Example
+
+Here is a simple example showing how to define a context and two steps. It showcases how context is passed between steps
+and how entry/exit assumptions (verification) are handled.
+
+```python
+from dataclasses import dataclass
+from junban.pipeline import Pipeline
+from junban.pipeline_step import PipelineStep
+from junban.pipeline_context import PipelineContext
+
+
+# 1. Define your context by inheriting from PipelineContext
+@dataclass
+class MyContext(PipelineContext):
+    value: int = 0
+    is_processed: bool = False
+
+
+# 2. Create pipeline steps by inheriting from PipelineStep
+class IncrementStep(PipelineStep[MyContext]):
+    def _check_entry_assumptions(self, context: MyContext) -> bool:
+        # Verification before step execution
+        return context.value == 0
+
+    def _execute(self, context: MyContext) -> MyContext:
+        # Core logic of the step
+        context.value += 1
+        return context
+
+    def _check_exit_assumptions(self, context: MyContext) -> bool:
+        # Verification after step execution
+        return context.value == 1
+
+    def get_start_message(self) -> str:
+        return "Incrementing value..."
+
+    def get_end_message(self) -> str:
+        return "Value incremented."
+
+
+class ProcessStep(PipelineStep[MyContext]):
+    def _check_entry_assumptions(self, context: MyContext) -> bool:
+        return context.value > 0
+
+    def _execute(self, context: MyContext) -> MyContext:
+        context.is_processed = True
+        return context
+
+    def _check_exit_assumptions(self, context: MyContext) -> bool:
+        return context.is_processed is True
+
+    def get_start_message(self) -> str:
+        return "Processing..."
+
+    def get_end_message(self) -> str:
+        return "Processed."
+
+
+# 3. Initialize and execute the pipeline
+if __name__ == "__main__":
+    context = MyContext()
+    pipeline = Pipeline(
+        steps=[IncrementStep(), ProcessStep()],
+        name="ExamplePipeline"
+    )
+
+    final_context = pipeline.execute(context)
+    print(f"Final value: {final_context.value}, Processed: {final_context.is_processed}")
+```

{junban-1.0.0 → junban-1.0.2}/README.md

@@ -4,9 +4,10 @@ Junban (english: order) is a lightweight library for defining and executing sequ
 
 ## Installation
 
-Junban is available via pypi:
-```python
+Junban is available via [pypi](https://pypi.org/project/junban/):
 
+```shell
+pip install junban
 ```
 
 ## Quick Example

junban-1.0.2/junban.egg-info/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: junban
+Version: 1.0.2
+Summary: Junban – Simple Sequential Python Workflows
+Author-email: Sebastian Franz <sebastian.franz@tum.de>
+Project-URL: Issues, https://github.com/biocentral/junban/issues
+Project-URL: Repository, https://github.com/biocentral/junban
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Junban (順番) – Simple Sequential Python Workflows
+
+Junban (english: order) is a lightweight library for defining and executing sequential (scientific) workflows in Python.
+
+## Installation
+
+Junban is available via [pypi](https://pypi.org/project/junban/):
+
+```shell
+pip install junban
+```
+
+## Quick Example
+
+Here is a simple example showing how to define a context and two steps. It showcases how context is passed between steps
+and how entry/exit assumptions (verification) are handled.
+
+```python
+from dataclasses import dataclass
+from junban.pipeline import Pipeline
+from junban.pipeline_step import PipelineStep
+from junban.pipeline_context import PipelineContext
+
+
+# 1. Define your context by inheriting from PipelineContext
+@dataclass
+class MyContext(PipelineContext):
+    value: int = 0
+    is_processed: bool = False
+
+
+# 2. Create pipeline steps by inheriting from PipelineStep
+class IncrementStep(PipelineStep[MyContext]):
+    def _check_entry_assumptions(self, context: MyContext) -> bool:
+        # Verification before step execution
+        return context.value == 0
+
+    def _execute(self, context: MyContext) -> MyContext:
+        # Core logic of the step
+        context.value += 1
+        return context
+
+    def _check_exit_assumptions(self, context: MyContext) -> bool:
+        # Verification after step execution
+        return context.value == 1
+
+    def get_start_message(self) -> str:
+        return "Incrementing value..."
+
+    def get_end_message(self) -> str:
+        return "Value incremented."
+
+
+class ProcessStep(PipelineStep[MyContext]):
+    def _check_entry_assumptions(self, context: MyContext) -> bool:
+        return context.value > 0
+
+    def _execute(self, context: MyContext) -> MyContext:
+        context.is_processed = True
+        return context
+
+    def _check_exit_assumptions(self, context: MyContext) -> bool:
+        return context.is_processed is True
+
+    def get_start_message(self) -> str:
+        return "Processing..."
+
+    def get_end_message(self) -> str:
+        return "Processed."
+
+
+# 3. Initialize and execute the pipeline
+if __name__ == "__main__":
+    context = MyContext()
+    pipeline = Pipeline(
+        steps=[IncrementStep(), ProcessStep()],
+        name="ExamplePipeline"
+    )
+
+    final_context = pipeline.execute(context)
+    print(f"Final value: {final_context.value}, Processed: {final_context.is_processed}")
+```

junban-1.0.2/pyproject.toml

@@ -0,0 +1,14 @@
+[project]
+name = "junban"
+version = "1.0.2"
+description = "Junban – Simple Sequential Python Workflows"
+authors = [
+    {name = "Sebastian Franz", email = "sebastian.franz@tum.de"},
+]
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = []
+
+[project.urls]
+Issues = "https://github.com/biocentral/junban/issues"
+Repository = "https://github.com/biocentral/junban"

junban-1.0.0/PKG-INFO

@@ -1,7 +0,0 @@
-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/junban.egg-info/PKG-INFO

@@ -1,7 +0,0 @@
-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/pyproject.toml

@@ -1,6 +0,0 @@
-[project]
-name = "junban"
-version = "1.0.0"
-description = "Junban – Simple Sequential Python Workflows"
-requires-python = ">=3.11"
-dependencies = []