pypeline-runner 1.2.0__tar.gz → 1.4.0__tar.gz

{pypeline_runner-1.2.0 → pypeline_runner-1.4.0}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: pypeline-runner
-Version: 1.2.0
+Version: 1.4.0
 Summary: Configure and execute pipelines with Python (similar to GitHub workflows or Jenkins pipelines).
-Home-page: https://github.com/cuinixam/pypeline
 License: MIT
 Author: cuinixam
 Author-email: me@cuinixam.com
@@ -20,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries
 Requires-Dist: py-app-dev (>=2.3.3,<3.0.0)
 Requires-Dist: pyyaml (>=6.0,<7.0)
-Requires-Dist: typer[all] (>=0.12,<0.13)
+Requires-Dist: typer (>=0.12,<0.13)
 Project-URL: Bug Tracker, https://github.com/cuinixam/pypeline/issues
 Project-URL: Changelog, https://github.com/cuinixam/pypeline/blob/main/CHANGELOG.md
 Project-URL: Documentation, https://pypeline-runner.readthedocs.io

{pypeline_runner-1.2.0 → pypeline_runner-1.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pypeline-runner"
-version = "1.2.0"
+version = "1.4.0"
 description = "Configure and execute pipelines with Python (similar to GitHub workflows or Jenkins pipelines)."
 authors = ["cuinixam <me@cuinixam.com>"]
 license = "MIT"
@@ -28,14 +28,14 @@ pypeline = "pypeline.main:main"
 [tool.poetry.dependencies]
 python = "^3.10"
 py-app-dev = "^2.3.3"
-typer = {extras = ["all"], version = "^0.12"}
+typer = "^0.12"
 pyyaml = "^6.0"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^7.0"
-pytest-cov = "^4.0"
-pre-commit = "^3.1"
-ruff = "^0.3"
+pytest = "^8.3"
+pytest-cov = "^6.0"
+pre-commit = "^4.0"
+ruff = "^0.9"
 
 [tool.poetry.group.docs.dependencies]
 myst-parser = ">=0.16"
@@ -72,7 +72,7 @@ match = "(?!main$)"
 prerelease = true
 
 [tool.pytest.ini_options]
-addopts = "-vv -Wdefault --cov=pypeline --cov-report=term-missing:skip-covered"
+addopts = "-vv -Wdefault --cov=pypeline --cov-report=term-missing:skip-covered --cov-branch"
 pythonpath = ["src"]
 
 [tool.coverage.run]

pypeline_runner-1.4.0/src/pypeline/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.4.0"

{pypeline_runner-1.2.0 → pypeline_runner-1.4.0}/src/pypeline/domain/pipeline.py

@@ -5,12 +5,15 @@ from typing import (
     Any,
     Dict,
     Generic,
+    Iterator,
     List,
     Optional,
     OrderedDict,
+    Tuple,
     Type,
     TypeAlias,
     TypeVar,
+    Union,
 )
 
 from mashumaro import DataClassDictMixin
@@ -29,8 +32,8 @@ class PipelineStepConfig(DataClassDictMixin):
     module: Optional[str] = None
     #: Step class name
     class_name: Optional[str] = None
-    #: Command to run. For simple steps that don't need a class
-    run: Optional[str] = None
+    #: Command to run. For simple steps that don't need a class. Example: run: [echo, 'Hello World!']
+    run: Optional[Union[str, List[str]]] = None
     #: Step description
     description: Optional[str] = None
     #: Step timeout in seconds
@@ -39,7 +42,27 @@ class PipelineStepConfig(DataClassDictMixin):
     config: Optional[Dict[str, Any]] = None
 
 
-PipelineConfig: TypeAlias = OrderedDict[str, List[PipelineStepConfig]]
+PipelineConfig: TypeAlias = Union[List[PipelineStepConfig], OrderedDict[str, List[PipelineStepConfig]]]
+
+
+class PipelineConfigIterator:
+    """
+    Iterates over the pipeline configuration, yielding group name and steps configuration.
+
+    This class abstracts the iteration logic for PipelineConfig, which can be:
+    - A list of steps (group name is None)
+    - An OrderedDict with group names as keys and lists of steps as values.
+
+    The iterator yields tuples of (group_name, steps).
+    """
+
+    def __init__(self, pipeline_config: PipelineConfig) -> None:
+        self._items = pipeline_config.items() if isinstance(pipeline_config, OrderedDict) else [(None, pipeline_config)]
+
+    def __iter__(self) -> Iterator[Tuple[Optional[str], List[PipelineStepConfig]]]:
+        """Return an iterator."""
+        yield from self._items
+
 
 TExecutionContext = TypeVar("TExecutionContext", bound=ExecutionContext)
 
@@ -47,7 +70,7 @@ TExecutionContext = TypeVar("TExecutionContext", bound=ExecutionContext)
 class PipelineStep(Generic[TExecutionContext], Runnable):
     """One can create subclasses of PipelineStep that specify the type of ExecutionContext they require."""
 
-    def __init__(self, execution_context: TExecutionContext, group_name: str, config: Optional[Dict[str, Any]] = None) -> None:
+    def __init__(self, execution_context: TExecutionContext, group_name: Optional[str], config: Optional[Dict[str, Any]] = None) -> None:
         super().__init__(self.get_needs_dependency_management())
         self.execution_context = execution_context
         self.group_name = group_name
@@ -56,7 +79,10 @@ class PipelineStep(Generic[TExecutionContext], Runnable):
 
     @property
     def output_dir(self) -> Path:
-        return self.execution_context.create_artifacts_locator().build_dir.joinpath(self.group_name)
+        output_dir = self.execution_context.create_artifacts_locator().build_dir
+        if self.group_name:
+            output_dir = output_dir / self.group_name
+        return output_dir
 
     @abstractmethod
     def update_execution_context(self) -> None:
@@ -73,7 +99,7 @@ class PipelineStep(Generic[TExecutionContext], Runnable):
 
 
 class PipelineStepReference(Generic[TExecutionContext]):
-    def __init__(self, group_name: str, _class: Type[PipelineStep[TExecutionContext]], config: Optional[Dict[str, Any]] = None) -> None:
+    def __init__(self, group_name: Optional[str], _class: Type[PipelineStep[TExecutionContext]], config: Optional[Dict[str, Any]] = None) -> None:
         self.group_name = group_name
         self._class = _class
         self.config = config

{pypeline_runner-1.2.0 → pypeline_runner-1.4.0}/src/pypeline/kickstart/templates/project/bootstrap.ps1

@@ -5,7 +5,7 @@
 
 function Invoke-Bootstrap {
     # Download bootstrap scripts from external repository
-    Invoke-RestMethod https://raw.githubusercontent.com/avengineers/bootstrap-installer/v1.15.0/install.ps1 | Invoke-Expression
+    Invoke-RestMethod https://raw.githubusercontent.com/avengineers/bootstrap-installer/v1.15.1/install.ps1 | Invoke-Expression
     # Execute bootstrap script
     . .\.bootstrap\bootstrap.ps1
 }

pypeline_runner-1.4.0/src/pypeline/kickstart/templates/project/pypeline.ps1

@@ -0,0 +1,7 @@
+Push-Location $PSScriptRoot
+try {
+    .\.venv\Scripts\pypeline.exe $args
+}
+finally {
+    Pop-Location
+}

pypeline_runner-1.4.0/src/pypeline/kickstart/templates/project/pypeline.yaml

@@ -0,0 +1,9 @@
+pipeline:
+  - step: CreateVEnv
+    module: pypeline.steps.create_venv
+    config:
+      bootstrap_script: .bootstrap/bootstrap.py
+  - step: ScoopInstall
+    module: pypeline.steps.scoop_install
+  - step: MyStep
+    file: steps/my_step.py

{pypeline_runner-1.2.0 → pypeline_runner-1.4.0}/src/pypeline/main.py

@@ -8,6 +8,7 @@ from py_app_dev.core.logging import logger, setup_logger, time_it
 
 from pypeline import __version__
 from pypeline.domain.execution_context import ExecutionContext
+from pypeline.domain.pipeline import PipelineConfigIterator
 from pypeline.domain.project_slurper import ProjectSlurper
 from pypeline.kickstart.create import KickstartProject
 from pypeline.pypeline import PipelineScheduler, PipelineStepsExecutor
@@ -69,8 +70,9 @@ def run(
     project_slurper = ProjectSlurper(project_dir)
     if print:
         logger.info("Pipeline steps:")
-        for group, step_configs in project_slurper.pipeline.items():
-            logger.info(f"    Group: {group}")
+        for group, step_configs in PipelineConfigIterator(project_slurper.pipeline):
+            if group:
+                logger.info(f"    Group: {group}")
             for step_config in step_configs:
                 logger.info(f"        {step_config.step}")
         return

{pypeline_runner-1.2.0 → pypeline_runner-1.4.0}/src/pypeline/pypeline.py

@@ -17,7 +17,7 @@ from py_app_dev.core.runnable import Executor
 
 from .domain.artifacts import ProjectArtifactsLocator
 from .domain.execution_context import ExecutionContext
-from .domain.pipeline import PipelineConfig, PipelineStep, PipelineStepConfig, PipelineStepReference, TExecutionContext
+from .domain.pipeline import PipelineConfig, PipelineConfigIterator, PipelineStep, PipelineStepConfig, PipelineStepReference, TExecutionContext
 
 
 class PipelineLoader(Generic[TExecutionContext]):
@@ -35,13 +35,13 @@ class PipelineLoader(Generic[TExecutionContext]):
 
     def load_steps_references(self) -> List[PipelineStepReference[TExecutionContext]]:
         result = []
-        for group_name, steps_config in self.pipeline_config.items():
+        for group_name, steps_config in PipelineConfigIterator(self.pipeline_config):
             result.extend(self._load_steps(group_name, steps_config, self.project_root_dir))
         return result
 
     @staticmethod
     def _load_steps(
-        group_name: str,
+        group_name: Optional[str],
         steps_config: List[PipelineStepConfig],
         project_root_dir: Path,
     ) -> List[PipelineStepReference[TExecutionContext]]:
@@ -53,7 +53,9 @@ class PipelineLoader(Generic[TExecutionContext]):
             elif step_config.file:
                 step_class = PipelineLoader._load_user_step(project_root_dir.joinpath(step_config.file), step_class_name)
             elif step_config.run:
-                step_class = PipelineLoader._create_run_command_step_class(step_config.run, step_class_name)
+                # We want the run field to always return a list of strings (the command and its arguments).
+                run_command = step_config.run.split(" ") if isinstance(step_config.run, str) else step_config.run
+                step_class = PipelineLoader._create_run_command_step_class(run_command, step_class_name)
             else:
                 raise UserNotificationException(f"Step '{step_class_name}' has no 'module' nor 'file' nor `run` defined." " Please check your pipeline configuration.")
             result.append(PipelineStepReference[TExecutionContext](group_name, cast(Type[PipelineStep[TExecutionContext]], step_class), step_config.config))
@@ -86,7 +88,7 @@ class PipelineLoader(Generic[TExecutionContext]):
         return step_class
 
     @staticmethod
-    def _create_run_command_step_class(command: str, name: str) -> Type[PipelineStep[ExecutionContext]]:
+    def _create_run_command_step_class(command: List[str], name: str) -> Type[PipelineStep[ExecutionContext]]:
         """Dynamically creates a step class for a given command."""
 
         class TmpDynamicRunCommandStep(PipelineStep[ExecutionContext]):
@@ -103,7 +105,8 @@ class PipelineLoader(Generic[TExecutionContext]):
 
             def run(self) -> int:
                 self.execution_context.create_process_executor(
-                    [self.command],
+                    # We have to disable type checking for the command because mypy considers that a List[str] is not compatible with a List[Union[str, Path]] :(
+                    self.command,  # type: ignore
                     cwd=self.project_root_dir,
                 ).execute()
                 return 0

{pypeline_runner-1.2.0 → pypeline_runner-1.4.0}/src/pypeline/steps/create_venv.py

@@ -19,7 +19,6 @@ class CreateVEnv(PipelineStep[ExecutionContext]):
     def __init__(self, execution_context: ExecutionContext, group_name: str, config: Optional[Dict[str, Any]] = None) -> None:
         super().__init__(execution_context, group_name, config)
         self.logger = logger.bind()
-        self.logger = logger.bind()
 
     @property
     def install_dirs(self) -> List[Path]:

pypeline_runner-1.2.0/src/pypeline/__init__.py

@@ -1 +0,0 @@
-__version__ = "1.2.0"

pypeline_runner-1.2.0/src/pypeline/kickstart/templates/project/pypeline.ps1

@@ -1 +0,0 @@
-.\.venv\Scripts\pypeline.exe $args

pypeline_runner-1.2.0/src/pypeline/kickstart/templates/project/pypeline.yaml

@@ -1,12 +0,0 @@
-pipeline:
-  venv:
-    - step: CreateVEnv
-      module: pypeline.steps.create_venv
-      config:
-        bootstrap_script: .bootstrap/bootstrap.py
-  install:
-    - step: ScoopInstall
-      module: pypeline.steps.scoop_install
-  custom:
-    - step: MyStep
-      file: steps/my_step.py