winipedia-utils 0.6.2__tar.gz → 0.6.4__tar.gz

{winipedia_utils-0.6.2 → winipedia_utils-0.6.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.6.2
+Version: 0.6.4
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE
@@ -157,13 +157,6 @@ Usually VSCode or other IDEs activates the venv automatically when opening the t
 
 Hooks run in the following order:
 
-- Fetch latest changes (git fetch origin)
-- Stash changes (git stash push -m "WIP: Stashed changes before rebasing")
-- Rebase on main (git rebase origin/main)
-- Pop stashed changes (git stash pop)
-- Add popped stash to git (git add ., bc unstashing unadds the changes and pre-commit fails, be aware that this might add changes you didn't want to commit, so inspect the changes before committing)
-- Patch version (poetry version patch)
-- Add version patch to git (git add pyproject.toml)
 - Update package manager (poetry self update)
 - Install packages (poetry install --with dev)
 - Update packages (poetry update --with dev (winipedia_utils forces all dependencies with * to be updated to latest compatible version))

{winipedia_utils-0.6.2 → winipedia_utils-0.6.4}/README.md

@@ -130,13 +130,6 @@ Usually VSCode or other IDEs activates the venv automatically when opening the t
 
 Hooks run in the following order:
 
-- Fetch latest changes (git fetch origin)
-- Stash changes (git stash push -m "WIP: Stashed changes before rebasing")
-- Rebase on main (git rebase origin/main)
-- Pop stashed changes (git stash pop)
-- Add popped stash to git (git add ., bc unstashing unadds the changes and pre-commit fails, be aware that this might add changes you didn't want to commit, so inspect the changes before committing)
-- Patch version (poetry version patch)
-- Add version patch to git (git add pyproject.toml)
 - Update package manager (poetry self update)
 - Install packages (poetry install --with dev)
 - Update packages (poetry update --with dev (winipedia_utils forces all dependencies with * to be updated to latest compatible version))

{winipedia_utils-0.6.2 → winipedia_utils-0.6.4}/pyproject.toml

@@ -1,7 +1,7 @@
 # Project section
 [project]
 name = "winipedia-utils"
-version = "0.6.2"
+version = "0.6.4"
 description = "A package with many utility functions"
 readme = "README.md"
 requires-python = ">=3.12"

winipedia_utils-0.6.4/winipedia_utils/artifacts/build.py

@@ -0,0 +1,78 @@
+"""Build utilities for creating and managing project builds.
+
+This module provides functions for building and managing project artifacts,
+including creating build scripts, configuring build environments, and
+handling build dependencies. These utilities help with the packaging and
+distribution of project code.
+"""
+
+import platform
+from abc import abstractmethod
+from pathlib import Path
+
+from winipedia_utils.git.github.workflows.base.base import Workflow
+from winipedia_utils.oop.mixins.mixin import ABCLoggingMixin
+
+
+class Build(ABCLoggingMixin):
+    """Base class for build scripts.
+
+    Subclass this class and implement the get_artifacts method to create
+    a build script for your project. The build method will be called
+    automatically when the class is initialized. At the end of the file add
+    if __name__ == "__main__":
+        YourBuildClass()
+    """
+
+    ARTIFACTS_PATH = Workflow.ARTIFACTS_PATH
+
+    @classmethod
+    @abstractmethod
+    def get_artifacts(cls) -> list[Path]:
+        """Build the project.
+
+        Returns:
+            list[Path]: List of paths to the built artifacts
+        """
+
+    @classmethod
+    def __init__(cls) -> None:
+        """Initialize the build script."""
+        cls.build()
+
+    @classmethod
+    def build(cls) -> None:
+        """Build the project.
+
+        This method is called by the __init__ method.
+        It takes all the files and renames them with -platform.system()
+        and puts them in the artifacts folder.
+        """
+        cls.ARTIFACTS_PATH.mkdir(parents=True, exist_ok=True)
+        artifacts = cls.get_artifacts()
+        for artifact in artifacts:
+            parent = artifact.parent
+            if parent != cls.ARTIFACTS_PATH:
+                msg = f"You must create {artifact} in {cls.ARTIFACTS_PATH}"
+                raise FileNotFoundError(msg)
+
+            # rename the files with -platform.system()
+            new_name = f"{artifact.stem}-{platform.system()}{artifact.suffix}"
+            new_path = cls.ARTIFACTS_PATH / new_name
+            artifact.rename(new_path)
+
+
+class WinipediaUtilsBuild(Build):
+    """Build script for winipedia_utils."""
+
+    @classmethod
+    def get_artifacts(cls) -> list[Path]:
+        """Build the project."""
+        paths = [cls.ARTIFACTS_PATH / "build.txt"]
+        for path in paths:
+            path.write_text("Hello World!")
+        return paths
+
+
+if __name__ == "__main__":
+    WinipediaUtilsBuild()

{winipedia_utils-0.6.2 → winipedia_utils-0.6.4}/winipedia_utils/git/github/workflows/release.py

@@ -67,7 +67,6 @@ class ReleaseWorkflow(HealthCheckWorkflow):
             return [cls.step_no_build_script()]
         return [
             *cls.steps_core_matrix_setup(),
-            cls.step_create_artifacts_folder(),
             cls.step_build_artifacts(),
             cls.step_upload_artifacts(),
         ]

{winipedia_utils-0.6.2 → winipedia_utils-0.6.4}/winipedia_utils/git/pre_commit/hooks.py

@@ -13,65 +13,6 @@ from winipedia_utils.projects.poetry.poetry import (
 )
 
 
-def fetch_latest_changes() -> list[str]:
-    """Fetch the latest changes from origin.
-
-    This function returns the input for subprocess.run() to fetch the latest
-    changes from origin.
-    """
-    return ["git", "fetch", "origin"]
-
-
-def stash_changes() -> list[str]:
-    """Stash the changes.
-
-    This function returns the input for subprocess.run() to stash the changes.
-    """
-    return [
-        "git",
-        "stash",
-        "push",
-        "-m",
-        "WIP: Temporarily stashed changes before rebasing",
-    ]
-
-
-def rebase_on_main() -> list[str]:
-    """Rebase the current branch on origin/main.
-
-    This function returns the input for subprocess.run() to rebase the current
-    branch on origin/main.
-    """
-    return ["git", "rebase", "origin/main"]
-
-
-def pop_stashed_changes() -> list[str]:
-    """Pop the stashed changes.
-
-    This function returns the input for subprocess.run() to pop the stashed changes.
-    """
-    return ["git", "stash", "pop"]
-
-
-def add_popped_stash_to_git() -> list[str]:
-    """Add the unstashed changes to git.
-
-    This function returns the input for subprocess.run() to add the unstashed
-    changes to git.
-    We must do git add . because unstashing unadds the changes and pre-commit fails
-    """
-    return ["git", "add", "."]
-
-
-def add_version_patch_to_git() -> list[str]:
-    """Add the version patch to git.
-
-    This function returns the input for subprocess.run() to add the version
-    patch to git, so that the hook does not fail bc the file was changed.
-    """
-    return ["git", "add", "pyproject.toml"]
-
-
 def update_package_manager() -> list[str]:
     """Update the package manager.
 

winipedia_utils-0.6.2/winipedia_utils/artifacts/build.py

@@ -1,19 +0,0 @@
-"""Build utilities for creating and managing project builds.
-
-This module provides functions for building and managing project artifacts,
-including creating build scripts, configuring build environments, and
-handling build dependencies. These utilities help with the packaging and
-distribution of project code.
-"""
-
-from winipedia_utils.git.github.workflows.base.base import Workflow
-
-
-def build_project() -> None:
-    """Build the project."""
-    # create a file with random content in BUILD_DIR
-    (Workflow.ARTIFACTS_PATH / "build.txt").write_text("Hello World!")
-
-
-if __name__ == "__main__":
-    build_project()