winipedia-utils 0.6.2__py3-none-any.whl → 0.6.3__py3-none-any.whl

winipedia_utils/artifacts/build.py

@@ -6,14 +6,73 @@ 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.name}-{platform.system()}"
+            new_path = cls.ARTIFACTS_PATH / new_name
+            artifact.rename(new_path)
+
 
+class WinipediaUtilsBuild(Build):
+    """Build script for winipedia_utils."""
 
-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!")
+    @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__":
-    build_project()
+    WinipediaUtilsBuild()

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.dist-info → winipedia_utils-0.6.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.6.2
+Version: 0.6.3
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE

{winipedia_utils-0.6.2.dist-info → winipedia_utils-0.6.3.dist-info}/RECORD

@@ -1,6 +1,6 @@
 winipedia_utils/__init__.py,sha256=vOWZ8n-YemVIzDLd8eWw1HVPGH3jxuT6VtDKHbmxk_A,43
 winipedia_utils/artifacts/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
-winipedia_utils/artifacts/build.py,sha256=WMlNcHwozg3oTmGSJLzsGAb-d4xuMvq51jetJNBkw-g,617
+winipedia_utils/artifacts/build.py,sha256=PsTJ1dMbNLZGG96s_4smUb_cDIEajFa6HI94hQgXTzU,2411
 winipedia_utils/concurrent/__init__.py,sha256=Tu0ig4gVCk_f1n74G35hDwH-WS3P3STVQGWjxTIbbo8,54
 winipedia_utils/concurrent/concurrent.py,sha256=h2vgxeDFsagZ10LnHKkswwF2bjY_L1hXKutejeJo48U,8648
 winipedia_utils/concurrent/multiprocessing.py,sha256=1pnAU-CS3crNOKlp68gCCvNbTvNJs0in_VASMpZ7M1c,4721
@@ -21,7 +21,7 @@ winipedia_utils/git/github/workflows/base/__init__.py,sha256=XHsbmjiaGom-KX-S3le
 winipedia_utils/git/github/workflows/base/base.py,sha256=Q2vTN98XlhDvLVjNEjDpAwQFchFXkPNuPNwAinqcPXE,28281
 winipedia_utils/git/github/workflows/health_check.py,sha256=Ghehk7LWV3ZH2283DRoNBEF3PDZtwNhiWwMq93CeDrk,2205
 winipedia_utils/git/github/workflows/publish.py,sha256=dNCcSBu7eTjmzomk3qX7BZpTzhwT5oM3Ap3hw22uoJE,1470
-winipedia_utils/git/github/workflows/release.py,sha256=WEAUglUFBE4OslzC_rnCHyLeIqo09majt2ps7UzA8jM,2928
+winipedia_utils/git/github/workflows/release.py,sha256=KgtbsAKlkBqNCsYKfdeN2OXINk4v2f9IK1Oh5eGplI0,2880
 winipedia_utils/git/gitignore/__init__.py,sha256=k-2E26JaZPkF69UUOJkpQl8T_PudrC7EYCIOxwgIQVU,57
 winipedia_utils/git/gitignore/config.py,sha256=Oi1gAf2mbR7vxMi0zsAFpCGzDaLNDd5S2vXEmA3eKg4,2595
 winipedia_utils/git/gitignore/gitignore.py,sha256=uE2MdynWgQuTG-y2YLR0FU5_giSE7s_TqSVQ6vnNOf8,2419
@@ -91,7 +91,7 @@ winipedia_utils/testing/tests/conftest.py,sha256=BLgUJtLecOwuEsIyJ__0buqovd5AhiG
 winipedia_utils/text/__init__.py,sha256=j2bwtK6kyeHI6SnoBjpRju0C1W2n2paXBDlNjNtaUxA,48
 winipedia_utils/text/config.py,sha256=jjKmn-tSbyaK6jGL0FxFHSREP6A6V1ZSX3RuIgvQ4io,7794
 winipedia_utils/text/string.py,sha256=uHqpm1yXumiSDD7MZxfdkRS_4paQ5wIJweeBJK2bCdQ,4332
-winipedia_utils-0.6.2.dist-info/METADATA,sha256=O4RWXegoBUm5RKCD3VdC7zUOonCCJSiDvRcawVL77Io,17002
-winipedia_utils-0.6.2.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-winipedia_utils-0.6.2.dist-info/licenses/LICENSE,sha256=o316mE2gGzd__JT69p7S_zlOmKiHh8YjpImCCcWyTvM,1066
-winipedia_utils-0.6.2.dist-info/RECORD,,
+winipedia_utils-0.6.3.dist-info/METADATA,sha256=_DzRAci7xJlhCmg3i216qV0cjsFPKAMvIGLsXuwqmow,17002
+winipedia_utils-0.6.3.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+winipedia_utils-0.6.3.dist-info/licenses/LICENSE,sha256=o316mE2gGzd__JT69p7S_zlOmKiHh8YjpImCCcWyTvM,1066
+winipedia_utils-0.6.3.dist-info/RECORD,,