pypeline-runner 0.1.0__py3-none-any.whl

pypeline/steps/create_venv.py

@@ -0,0 +1,43 @@
+from pathlib import Path
+from typing import List
+
+from py_app_dev.core.exceptions import UserNotificationException
+from py_app_dev.core.logging import logger
+
+from ..domain.execution_context import ExecutionContext
+from ..domain.pipeline import PipelineStep
+
+
+class CreateVEnv(PipelineStep):
+    def __init__(self, execution_context: ExecutionContext, output_dir: Path) -> None:
+        super().__init__(execution_context, output_dir)
+        self.logger = logger.bind()
+        self.logger = logger.bind()
+
+    @property
+    def install_dirs(self) -> List[Path]:
+        return [self.project_root_dir / dir for dir in [".venv/Scripts", ".venv/bin"] if (self.project_root_dir / dir).exists()]
+
+    def get_name(self) -> str:
+        return self.__class__.__name__
+
+    def run(self) -> int:
+        self.logger.debug(f"Run {self.get_name()} step. Output dir: {self.output_dir}")
+        build_script_path = self.project_root_dir / "bootstrap.py"
+        if not build_script_path.exists():
+            raise UserNotificationException("Failed to find bootstrap script. Make sure that the project is initialized correctly.")
+        self.execution_context.create_process_executor(
+            ["python", build_script_path.as_posix()],
+            cwd=self.project_root_dir,
+        ).execute()
+        self.execution_context.add_install_dirs(self.install_dirs)
+        return 0
+
+    def get_inputs(self) -> List[Path]:
+        return []
+
+    def get_outputs(self) -> List[Path]:
+        return []
+
+    def update_execution_context(self) -> None:
+        pass

pypeline/steps/scoop_install.py

@@ -0,0 +1,87 @@
+import io
+import json
+import traceback
+from dataclasses import dataclass
+from pathlib import Path
+from typing import ClassVar, List
+
+from mashumaro.config import TO_DICT_ADD_OMIT_NONE_FLAG, BaseConfig
+from mashumaro.mixins.json import DataClassJSONMixin
+from py_app_dev.core.exceptions import UserNotificationException
+from py_app_dev.core.logging import logger
+from py_app_dev.core.scoop_wrapper import ScoopWrapper
+
+from ..domain.execution_context import ExecutionContext
+from ..domain.pipeline import PipelineStep
+
+
+@dataclass
+class ScoopInstallExecutionInfo(DataClassJSONMixin):
+    install_dirs: List[Path]
+
+    class Config(BaseConfig):
+        """Base configuration for JSON serialization with omitted None values."""
+
+        code_generation_options: ClassVar[List[str]] = [TO_DICT_ADD_OMIT_NONE_FLAG]
+
+    @classmethod
+    def from_json_file(cls, file_path: Path) -> "ScoopInstallExecutionInfo":
+        try:
+            result = cls.from_dict(json.loads(file_path.read_text()))
+        except Exception as e:
+            output = io.StringIO()
+            traceback.print_exc(file=output)
+            raise UserNotificationException(output.getvalue()) from e
+        return result
+
+    def to_json_string(self) -> str:
+        return json.dumps(self.to_dict(omit_none=True), indent=2)
+
+    def to_json_file(self, file_path: Path) -> None:
+        file_path.write_text(self.to_json_string())
+
+
+def create_scoop_wrapper() -> ScoopWrapper:
+    return ScoopWrapper()
+
+
+class ScoopInstall(PipelineStep):
+    def __init__(self, execution_context: ExecutionContext, output_dir: Path) -> None:
+        super().__init__(execution_context, output_dir)
+        self.logger = logger.bind()
+        self.execution_info = ScoopInstallExecutionInfo([])
+        # One needs to keep track of the installed apps to get the required paths
+        # even if the step does not need to run.
+        self.execution_info_file = self.output_dir.joinpath("scoop_install_exec_info.json")
+
+    def get_name(self) -> str:
+        return self.__class__.__name__
+
+    @property
+    def install_dirs(self) -> List[Path]:
+        return self.execution_info.install_dirs
+
+    @property
+    def scoop_file(self) -> Path:
+        return self.project_root_dir.joinpath("scoopfile.json")
+
+    def run(self) -> int:
+        self.logger.debug(f"Run {self.get_name()} step. Output dir: {self.output_dir}")
+        installed_apps = create_scoop_wrapper().install(self.scoop_file)
+        for app in installed_apps:
+            self.install_dirs.extend(app.get_all_required_paths())
+        self.execution_info.to_json_file(self.execution_info_file)
+        return 0
+
+    def get_inputs(self) -> List[Path]:
+        return [self.scoop_file]
+
+    def get_outputs(self) -> List[Path]:
+        return self.install_dirs
+
+    def update_execution_context(self) -> None:
+        install_dirs = ScoopInstallExecutionInfo.from_json_file(self.execution_info_file).install_dirs
+        # Make the list unique and keep the order
+        unique_paths = list(dict.fromkeys(install_dirs))
+        # Update the install directories for the subsequent steps
+        self.execution_context.add_install_dirs(unique_paths)

pypeline/steps/west_install.py

@@ -0,0 +1,54 @@
+from pathlib import Path
+from typing import List
+
+from py_app_dev.core.exceptions import UserNotificationException
+from py_app_dev.core.logging import logger
+
+from ..domain.execution_context import ExecutionContext
+from ..domain.pipeline import PipelineStep
+
+
+class WestInstall(PipelineStep):
+    def __init__(self, execution_context: ExecutionContext, output_dir: Path) -> None:
+        super().__init__(execution_context, output_dir)
+        self.logger = logger.bind()
+        self.artifacts_locator = execution_context.create_artifacts_locator()
+
+    def get_name(self) -> str:
+        return self.__class__.__name__
+
+    @property
+    def west_manifest_file(self) -> Path:
+        return self.project_root_dir.joinpath("west.yaml")
+
+    def run(self) -> int:
+        self.logger.debug(f"Run {self.get_name()} step. Output dir: {self.output_dir}")
+        try:
+            self.execution_context.create_process_executor(
+                [
+                    "west",
+                    "init",
+                    "-l",
+                    "--mf",
+                    self.west_manifest_file.as_posix(),
+                    self.artifacts_locator.build_dir.joinpath("west").as_posix(),
+                ],
+                cwd=self.project_root_dir,
+            ).execute()
+            self.execution_context.create_process_executor(
+                ["west", "update"],
+                cwd=self.artifacts_locator.build_dir,
+            ).execute()
+        except Exception as e:
+            raise UserNotificationException(f"Failed to initialize and update with west: {e}") from e
+
+        return 0
+
+    def get_inputs(self) -> List[Path]:
+        return [self.west_manifest_file]
+
+    def get_outputs(self) -> List[Path]:
+        return []
+
+    def update_execution_context(self) -> None:
+        pass

pypeline_runner-0.1.0.dist-info/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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,30 @@
+pypeline/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+pypeline/__run.py,sha256=TCdaX05Qm3g8T4QYryKB25Xxf0L5Km7hFOHe1mK9vI0,350
+pypeline/domain/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pypeline/domain/artifacts.py,sha256=qXshnk9umi0AVGV4m5iEiy_MQ5Ad2LDZwI8OULU-qMk,1355
+pypeline/domain/config.py,sha256=HpU-d_oHZYCCbc1Fer3BJwAma94eL97eXTtKZEsrVpQ,1491
+pypeline/domain/execution_context.py,sha256=0zc3OgXeIMDpgWWYMaDGub7fY5urLLR79yuCaXVxoTQ,1101
+pypeline/domain/pipeline.py,sha256=VzzYqi3WyDmXN3UblTrfcirmh2PXqrdt_Gfi1Qtkln0,817
+pypeline/domain/project_slurper.py,sha256=YCho7V1BHjFmC_foxHFaWX8c_VbMJ16XEB4CQBlMrhc,894
+pypeline/kickstart/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pypeline/kickstart/create.py,sha256=iTf7I5POHTKXZ7RuZ6iVHsBT8D02Nws-h0ZH53Rk2cI,2410
+pypeline/kickstart/templates/bootstrap/bootstrap.ps1,sha256=IcgNohR8Fllz234DXQOl4N59I38t0mZ0k6ziu3Uu2kA,5772
+pypeline/kickstart/templates/bootstrap/bootstrap.py,sha256=9DstyqJFVcBHOs5cS2dU43FY7dLusid5KEi55TeaJwk,15971
+pypeline/kickstart/templates/project/.gitignore,sha256=vX-IAjvkjxgNIYBQmqaRRhWRO2uONl0GR355PiQPjIk,13
+pypeline/kickstart/templates/project/poetry.toml,sha256=q5gF2MWexTFIahJ6StUa3y62HDUrRW7t8kGFszZhgp4,34
+pypeline/kickstart/templates/project/pypeline.yaml,sha256=i9YSqpS2o-_Bzl69fvdOFVyYRMsDCtDy8usBpk-hqnE,219
+pypeline/kickstart/templates/project/pyproject.toml,sha256=nz0K93bcLW3zikxdg39Pl030VoXZiUj78mFfgAw0Fk8,202
+pypeline/kickstart/templates/project/scoopfile.json,sha256=DcfZ8jYf9hmPHM-AWwnPKQJCzRG3fCuYtMeoY01nkag,219
+pypeline/kickstart/templates/project/steps/my_step.py,sha256=YNRdb7ofqo3PxMQe8Vhtf7K9eZclv-6J0IwMrd3E70w,651
+pypeline/main.py,sha256=f8SMN_RUU35lv7dNnBDIzrBOpe76YGuRS6ouJ1zkNlI,3365
+pypeline/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pypeline/pypeline.py,sha256=yZ4nIBtI7Yrz-d8rmslERdtwcJiBf1D9tpOHFR5iAvM,4235
+pypeline/steps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pypeline/steps/create_venv.py,sha256=HeoJYDdyGEOwFnK_9eYEK32l6F9MpEsYSiM91uLVt2o,1599
+pypeline/steps/scoop_install.py,sha256=KozpYMG1qITo21u6cIf9USkjIp2gvZ3V2DMzhi8fVyg,3257
+pypeline/steps/west_install.py,sha256=QUopdIJne6OFhaXNlbOYrOGDPmNy6kgqZfOiUWQN7xY,1860
+pypeline_runner-0.1.0.dist-info/LICENSE,sha256=sKxdoqSmW9ezvPvt0ZGJbneyA0SBcm0GiqzTv2jN230,1066
+pypeline_runner-0.1.0.dist-info/METADATA,sha256=Iu5SHcaY61DS-qKvDhwYLh9bkwGvAkwnE1mm-U7UCbo,5755
+pypeline_runner-0.1.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+pypeline_runner-0.1.0.dist-info/entry_points.txt,sha256=pe1u0uuhPI_yeQ0KjEw6jK-EvQfPcZwBSajgbAdKz1o,47
+pypeline_runner-0.1.0.dist-info/RECORD,,

pypeline_runner-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pypeline_runner-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+pypeline=pypeline.main:main
+