pypeline-runner 0.1.0__tar.gz

pypeline_runner-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2024 cuinixam
+
+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.

pypeline_runner-0.1.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.1
+Name: pypeline-runner
+Version: 0.1.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
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Requires-Dist: py-app-dev (>=2.1.0,<3.0.0)
+Requires-Dist: typer[all] (>=0.12.0,<0.13.0)
+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
+Project-URL: Repository, https://github.com/cuinixam/pypeline
+Description-Content-Type: text/markdown
+
+# Python Pipeline
+
+<p align="center">
+  <a href="https://github.com/cuinixam/pypeline/actions/workflows/ci.yml?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/cuinixam/pypeline/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
+  </a>
+  <a href="https://pypeline.readthedocs.io">
+    <img src="https://img.shields.io/readthedocs/pypeline.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
+  </a>
+  <a href="https://codecov.io/gh/cuinixam/pypeline">
+    <img src="https://img.shields.io/codecov/c/github/cuinixam/pypeline.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
+  </a>
+</p>
+<p align="center">
+  <a href="https://python-poetry.org/">
+    <img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=" alt="Poetry">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="ruff">
+  </a>
+  <a href="https://github.com/pre-commit/pre-commit">
+    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
+  </a>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/pypeline/">
+    <img src="https://img.shields.io/pypi/v/pypeline.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/pypeline.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/pypeline.svg?style=flat-square" alt="License">
+</p>
+
+Configure and execute steps for developing a python package.
+
+## Installation
+
+Install this via pip (or your favourite package manager):
+
+`pip install pypeline`
+
+## Start developing
+
+The project uses Poetry for dependencies management and packaging.
+Run the `bootstrap.ps1` script to install Python and create the virtual environment.
+
+```powershell
+.\bootstrap.ps1
+```
+
+This will also generate a `poetry.lock` file, you should track this file in version control.
+
+To execute the test suite, call pytest inside Poetry's virtual environment via `poetry run`:
+
+```shell
+.venv/Scripts/poetry run pytest
+```
+
+Check out the Poetry documentation for more information on the available commands.
+
+For those using [VS Code](https://code.visualstudio.com/) there are tasks defined for the most common commands:
+
+- bootstrap
+- install dependencies
+- run tests
+- run all checks configured for pre-commit
+- generate documentation
+
+See the `.vscode/tasks.json` for more details.
+
+## Committing changes
+
+This repository uses [commitlint](https://github.com/conventional-changelog/commitlint) for checking if the commit message meets the [conventional commit format](https://www.conventionalcommits.org/en).
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- prettier-ignore-start -->
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-enable -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- prettier-ignore-end -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## Credits
+
+This package was created with
+[Copier](https://copier.readthedocs.io/) and the
+[cuinixam/pypackage-template](https://github.com/cuinixam/pypackage-template)
+project template.
+

pypeline_runner-0.1.0/README.md

@@ -0,0 +1,92 @@
+# Python Pipeline
+
+<p align="center">
+  <a href="https://github.com/cuinixam/pypeline/actions/workflows/ci.yml?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/cuinixam/pypeline/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
+  </a>
+  <a href="https://pypeline.readthedocs.io">
+    <img src="https://img.shields.io/readthedocs/pypeline.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
+  </a>
+  <a href="https://codecov.io/gh/cuinixam/pypeline">
+    <img src="https://img.shields.io/codecov/c/github/cuinixam/pypeline.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
+  </a>
+</p>
+<p align="center">
+  <a href="https://python-poetry.org/">
+    <img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=" alt="Poetry">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="ruff">
+  </a>
+  <a href="https://github.com/pre-commit/pre-commit">
+    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
+  </a>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/pypeline/">
+    <img src="https://img.shields.io/pypi/v/pypeline.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/pypeline.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/pypeline.svg?style=flat-square" alt="License">
+</p>
+
+Configure and execute steps for developing a python package.
+
+## Installation
+
+Install this via pip (or your favourite package manager):
+
+`pip install pypeline`
+
+## Start developing
+
+The project uses Poetry for dependencies management and packaging.
+Run the `bootstrap.ps1` script to install Python and create the virtual environment.
+
+```powershell
+.\bootstrap.ps1
+```
+
+This will also generate a `poetry.lock` file, you should track this file in version control.
+
+To execute the test suite, call pytest inside Poetry's virtual environment via `poetry run`:
+
+```shell
+.venv/Scripts/poetry run pytest
+```
+
+Check out the Poetry documentation for more information on the available commands.
+
+For those using [VS Code](https://code.visualstudio.com/) there are tasks defined for the most common commands:
+
+- bootstrap
+- install dependencies
+- run tests
+- run all checks configured for pre-commit
+- generate documentation
+
+See the `.vscode/tasks.json` for more details.
+
+## Committing changes
+
+This repository uses [commitlint](https://github.com/conventional-changelog/commitlint) for checking if the commit message meets the [conventional commit format](https://www.conventionalcommits.org/en).
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- prettier-ignore-start -->
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-enable -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- prettier-ignore-end -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## Credits
+
+This package was created with
+[Copier](https://copier.readthedocs.io/) and the
+[cuinixam/pypackage-template](https://github.com/cuinixam/pypackage-template)
+project template.

pypeline_runner-0.1.0/pyproject.toml

@@ -0,0 +1,163 @@
+[tool.poetry]
+name = "pypeline-runner"
+version = "0.1.0"
+description = "Configure and execute pipelines with Python (similar to GitHub workflows or Jenkins pipelines)."
+authors = ["cuinixam <me@cuinixam.com>"]
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/cuinixam/pypeline"
+documentation = "https://pypeline-runner.readthedocs.io"
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries",
+]
+packages = [
+    { include = "pypeline", from = "src" },
+]
+
+[tool.poetry.scripts]
+pypeline = "pypeline.main:main"
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/cuinixam/pypeline/issues"
+"Changelog" = "https://github.com/cuinixam/pypeline/blob/main/CHANGELOG.md"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+py-app-dev = "^2.1.0"
+typer = {extras = ["all"], version = "^0.12.0"}
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.0"
+pytest-cov = "^4.0"
+pre-commit = "^3.1.1"
+ruff = "^0.3.0"
+
+[tool.poetry.group.docs.dependencies]
+myst-parser = ">=0.16"
+sphinx = ">=4.0"
+sphinxcontrib-mermaid = "^0.8.1"
+mlx-traceability = "^10.0.0"
+sphinx-copybutton = "^0.5.2"
+sphinx-new-tab-link = "^0.2.2"
+sphinx-book-theme = "^1.1.2"
+sphinx-design = "^0.5.0"
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:tool.poetry.version"]
+version_variables = [
+    "src/pypeline/__init__.py:__version__",
+    "docs/conf.py:release",
+]
+build_command = "pip install poetry && poetry build"
+
+[tool.semantic_release.changelog]
+exclude_commit_patterns = [
+    "chore*",
+    "ci*",
+]
+
+[tool.semantic_release.changelog.environment]
+keep_trailing_newline = true
+
+[tool.semantic_release.branches.main]
+match = "main"
+
+[tool.semantic_release.branches.noop]
+match = "(?!main$)"
+prerelease = true
+
+[tool.pytest.ini_options]
+addopts = "-vv -Wdefault --cov=pypeline --cov-report=term-missing:skip-covered"
+pythonpath = ["src"]
+
+[tool.coverage.run]
+branch = true
+source = ['src/']
+omit = ['*/__run.py']
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "@overload",
+    "if TYPE_CHECKING",
+    "raise NotImplementedError",
+    'if __name__ == "__main__":',
+]
+
+
+[tool.ruff]
+target-version = "py38"
+line-length = 180
+lint.ignore = [
+    "D203", # 1 blank line required before class docstring
+    "D212", # Multi-line docstring summary should start at the first line
+    "D100", # Missing docstring in public module
+    "D101", # Missing docstring in public class
+    "D102", # Missing docstring in public method
+    "D103", # Missing docstring in public function
+    "D104", # Missing docstring in public package
+    "D107", # Missing docstring in `__init__`
+    "D401", # First line of docstring should be in imperative mood
+]
+lint.select = [
+    "B",   # flake8-bugbear
+    "D",   # flake8-docstrings
+    "C4",  # flake8-comprehensions
+    "S",   # flake8-bandit
+    "F",   # pyflake
+    "E",   # pycodestyle
+    "W",   # pycodestyle
+    "UP",  # pyupgrade
+    "I",   # isort
+    "RUF", # ruff specific
+]
+exclude = [
+    "bootstrap.py"
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*" = [
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "S101",
+]
+"setup.py" = ["D100"]
+"conftest.py" = ["D100"]
+"docs/conf.py" = ["D100"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["pypeline", "tests"]
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+mypy_path = "src/"
+no_implicit_optional = true
+show_error_codes = true
+warn_unreachable = true
+warn_unused_ignores = true
+exclude = [
+    'docs/.*',
+    'setup.py',
+]
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+allow_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = "docs.*"
+ignore_errors = true
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

pypeline_runner-0.1.0/src/pypeline/__init__.py

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

pypeline_runner-0.1.0/src/pypeline/__run.py

@@ -0,0 +1,12 @@
+"""
+Used to run pypeline from the command line when run from this repository.
+
+This is required because pypeline module is not visible when running from the repository.
+"""
+
+import runpy
+import sys
+from pathlib import Path
+
+sys.path.insert(0, Path(__file__).parent.parent.absolute().as_posix())
+runpy.run_module("pypeline.main", run_name="__main__")

pypeline_runner-0.1.0/src/pypeline/domain/artifacts.py

@@ -0,0 +1,36 @@
+import sys
+from pathlib import Path
+from typing import List, Optional
+
+from py_app_dev.core.exceptions import UserNotificationException
+
+CONFIG_FILENAME = "pypeline.yaml"
+
+
+class ProjectArtifactsLocator:
+    """Provides paths to project artifacts."""
+
+    def __init__(
+        self,
+        project_root_dir: Path,
+    ) -> None:
+        self.project_root_dir = project_root_dir
+        self.build_dir = project_root_dir / "build"
+        self.config_file = project_root_dir / CONFIG_FILENAME
+        self.external_dependencies_dir = self.build_dir / "external"
+        scripts_dir = "Scripts" if sys.platform.startswith("win32") else "bin"
+        self.venv_scripts_dir = self.project_root_dir.joinpath(".venv").joinpath(scripts_dir)
+
+    def locate_artifact(self, artifact: str, first_search_paths: List[Optional[Path]]) -> Path:
+        search_paths = []
+        for path in first_search_paths:
+            if path:
+                search_paths.append(path.parent if path.is_file() else path)
+        for dir in [
+            *search_paths,
+            self.project_root_dir,
+        ]:
+            if dir and (artifact_path := Path(dir).joinpath(artifact)).exists():
+                return artifact_path
+        else:
+            raise UserNotificationException(f"Artifact '{artifact}' not found in the project.")

pypeline_runner-0.1.0/src/pypeline/domain/config.py

@@ -0,0 +1,36 @@
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any, Dict, Optional
+
+import yaml
+from mashumaro import DataClassDictMixin
+from py_app_dev.core.exceptions import UserNotificationException
+from py_app_dev.core.pipeline import PipelineConfig
+from yaml.parser import ParserError
+from yaml.scanner import ScannerError
+
+
+@dataclass
+class ProjectConfig(DataClassDictMixin):
+    pipeline: PipelineConfig
+    # This field is intended to keep track of where configuration was loaded from and
+    # it is automatically added when configuration is loaded from file
+    file: Optional[Path] = None
+
+    @classmethod
+    def from_file(cls, config_file: Path) -> "ProjectConfig":
+        config_dict = cls.parse_to_dict(config_file)
+        return cls.from_dict(config_dict)
+
+    @staticmethod
+    def parse_to_dict(config_file: Path) -> Dict[str, Any]:
+        try:
+            with open(config_file) as fs:
+                config_dict = yaml.safe_load(fs)
+                # Add file name to config to keep track of where configuration was loaded from
+                config_dict["file"] = config_file
+            return config_dict
+        except ScannerError as e:
+            raise UserNotificationException(f"Failed scanning configuration file '{config_file}'. \nError: {e}") from e
+        except ParserError as e:
+            raise UserNotificationException(f"Failed parsing configuration file '{config_file}'. \nError: {e}") from e

pypeline_runner-0.1.0/src/pypeline/domain/execution_context.py

@@ -0,0 +1,27 @@
+import os
+from dataclasses import dataclass, field
+from pathlib import Path
+from typing import List, Optional
+
+from py_app_dev.core.subprocess import SubprocessExecutor
+
+from .artifacts import ProjectArtifactsLocator
+
+
+@dataclass
+class ExecutionContext:
+    project_root_dir: Path
+    # Keep track of all install directories, updated by any step for the subsequent steps
+    install_dirs: List[Path] = field(default_factory=list)
+
+    def add_install_dirs(self, install_dirs: List[Path]) -> None:
+        self.install_dirs.extend(install_dirs)
+
+    def create_process_executor(self, command: List[str | Path], cwd: Optional[Path] = None) -> SubprocessExecutor:
+        # Add the install directories to the PATH
+        env = os.environ.copy()
+        env["PATH"] = os.pathsep.join([path.absolute().as_posix() for path in self.install_dirs] + [env["PATH"]])
+        return SubprocessExecutor(command, cwd=cwd, env=env, shell=True)  # noqa: S604
+
+    def create_artifacts_locator(self) -> ProjectArtifactsLocator:
+        return ProjectArtifactsLocator(self.project_root_dir)

pypeline_runner-0.1.0/src/pypeline/domain/pipeline.py

@@ -0,0 +1,28 @@
+from abc import abstractmethod
+from pathlib import Path
+from typing import Type
+
+from py_app_dev.core.runnable import Runnable
+
+from .execution_context import ExecutionContext
+
+
+class PipelineStep(Runnable):
+    def __init__(self, execution_context: ExecutionContext, output_dir: Path) -> None:
+        self.execution_context = execution_context
+        self.output_dir = output_dir
+        self.project_root_dir = self.execution_context.project_root_dir
+
+    @abstractmethod
+    def update_execution_context(self) -> None:
+        pass
+
+
+class PipelineStepReference:
+    def __init__(self, group_name: str, _class: Type[PipelineStep]) -> None:
+        self.group_name = group_name
+        self._class = _class
+
+    @property
+    def name(self) -> str:
+        return self._class.__name__

pypeline_runner-0.1.0/src/pypeline/domain/project_slurper.py

@@ -0,0 +1,22 @@
+from pathlib import Path
+
+from py_app_dev.core.exceptions import UserNotificationException
+from py_app_dev.core.logging import logger
+
+from .artifacts import ProjectArtifactsLocator
+from .config import PipelineConfig, ProjectConfig
+
+
+class ProjectSlurper:
+    def __init__(self, project_dir: Path) -> None:
+        self.logger = logger.bind()
+        self.artifacts_locator = ProjectArtifactsLocator(project_dir)
+        try:
+            self.user_config: ProjectConfig = ProjectConfig.from_file(self.artifacts_locator.config_file)
+        except FileNotFoundError:
+            raise UserNotificationException(f"Project configuration file '{self.artifacts_locator.config_file}' not found.") from None
+        self.pipeline: PipelineConfig = self.user_config.pipeline
+
+    @property
+    def project_dir(self) -> Path:
+        return self.artifacts_locator.project_root_dir

pypeline_runner-0.1.0/src/pypeline/kickstart/create.py

@@ -0,0 +1,58 @@
+import shutil
+from pathlib import Path
+from typing import List, Optional, Union
+
+from py_app_dev.core.exceptions import UserNotificationException
+from py_app_dev.core.logging import logger
+
+
+class ProjectBuilder:
+    def __init__(self, project_dir: Path, input_dir: Optional[Path] = None) -> None:
+        self.project_dir = project_dir
+        self.input_dir = input_dir if input_dir else Path(__file__).parent.joinpath("templates")
+
+        self.dirs: List[Path] = []
+        self.check_target_directory_flag = True
+
+    def with_disable_target_directory_check(self) -> "ProjectBuilder":
+        self.check_target_directory_flag = False
+        return self
+
+    def with_dir(self, dir: Union[Path, str]) -> "ProjectBuilder":
+        self.dirs.append(self.resolve_file_path(dir))
+        return self
+
+    def resolve_file_paths(self, files: List[Path | str]) -> List[Path]:
+        return [self.resolve_file_path(file) for file in files]
+
+    def resolve_file_path(self, file: Union[Path, str]) -> Path:
+        return self.input_dir.joinpath(file) if isinstance(file, str) else file
+
+    @staticmethod
+    def _check_target_directory(project_dir: Path) -> None:
+        if project_dir.is_dir() and any(project_dir.iterdir()):
+            raise UserNotificationException(f"Project directory '{project_dir}' is not empty." " The target directory shall either be empty or not exist.")
+
+    def build(self) -> None:
+        if self.check_target_directory_flag:
+            self._check_target_directory(self.project_dir)
+        for dir in self.dirs:
+            shutil.copytree(dir, self.project_dir, dirs_exist_ok=True)
+
+
+class KickstartProject:
+    def __init__(self, project_dir: Path, bootstrap_only: bool = False, force: bool = False) -> None:
+        self.logger = logger.bind()
+        self.project_dir = project_dir
+        self.bootstrap_only = bootstrap_only
+        self.force = force
+
+    def run(self) -> None:
+        self.logger.info(f"Kickstart new project in '{self.project_dir.absolute().as_posix()}'")
+        project_builder = ProjectBuilder(self.project_dir)
+        project_builder.with_dir("bootstrap")
+        if self.bootstrap_only or self.force:
+            project_builder.with_disable_target_directory_check()
+        if not self.bootstrap_only:
+            project_builder.with_dir("project")
+        project_builder.build()