winipedia-utils 0.5.22__py3-none-any.whl → 0.5.30__py3-none-any.whl

winipedia_utils/git/github/workflows/health_check.py

@@ -6,7 +6,6 @@ This workflow is used to run tests on pull requests.
 from typing import Any
 
 from winipedia_utils.git.github.workflows.base.base import Workflow
-from winipedia_utils.projects.poetry.config import PyprojectConfigFile
 
 
 class HealthCheckWorkflow(Workflow):
@@ -19,62 +18,53 @@ class HealthCheckWorkflow(Workflow):
     @classmethod
     def get_workflow_triggers(cls) -> dict[str, Any]:
         """Get the workflow triggers."""
-        return {
-            "pull_request": {
-                "types": ["opened", "synchronize", "reopened"],
-            },
-            "schedule": [
-                {
-                    # run every day at 6 am
-                    "cron": "0 6 * * *",
-                },
-            ],
-            "workflow_dispatch": {},
-        }
-
-    @classmethod
-    def get_permissions(cls) -> dict[str, Any]:
-        """Get the workflow permissions."""
-        return {}
+        triggers = super().get_workflow_triggers()
+        triggers.update(cls.on_pull_request())
+        triggers.update(cls.on_schedule(cron="0 6 * * *"))
+        return triggers
 
     @classmethod
     def get_jobs(cls) -> dict[str, Any]:
         """Get the workflow jobs."""
-        matrix_job_name = f"{cls.get_filename()}_matrix"
-        return {
-            **cls.get_standard_job(
-                name=matrix_job_name,
-                runs_on="${{ matrix.os }}",
-                strategy={
-                    "matrix": {
-                        "os": ["ubuntu-latest", "windows-latest", "macos-latest"],
-                        "python-version": [
-                            str(v)
-                            for v in PyprojectConfigFile.get_supported_python_versions()
-                        ],
-                    },
-                    "fail-fast": True,
-                },
-                steps=[
-                    *(
-                        cls.get_poetry_setup_steps(
-                            install_dependencies=True,
-                            repo_token=True,
-                            with_keyring=True,
-                            strategy_matrix=True,
-                        )
-                    ),
-                    cls.get_protect_repository_step(),
-                    cls.get_pre_commit_step(),
-                ],
-            ),
-            **cls.get_standard_job(
-                needs=[matrix_job_name],
-                steps=[
-                    {
-                        "name": "Aggregate Matrix Results",
-                        "run": "echo 'Aggregating matrix results into one job.'",
-                    }
-                ],
+        jobs: dict[str, Any] = {}
+        jobs.update(cls.job_health_check_matrix())
+        jobs.update(cls.job_health_check())
+        return jobs
+
+    @classmethod
+    def job_health_check_matrix(cls) -> dict[str, Any]:
+        """Get the health check matrix job."""
+        return cls.get_job(
+            job_func=cls.job_health_check_matrix,
+            strategy=cls.strategy_matrix_os_and_python_version(),
+            runs_on=cls.insert_matrix_os(),
+            steps=cls.steps_health_check_matrix(),
+        )
+
+    @classmethod
+    def job_health_check(cls) -> dict[str, Any]:
+        """Get the health check job."""
+        return cls.get_job(
+            job_func=cls.job_health_check,
+            needs=[cls.make_id_from_func(cls.job_health_check_matrix)],
+            steps=cls.steps_aggregate_matrix_results(),
+        )
+
+    @classmethod
+    def steps_health_check_matrix(cls) -> list[dict[str, Any]]:
+        """Get the health check matrix steps."""
+        return [
+            *cls.steps_core_matrix_setup(
+                python_version=cls.insert_matrix_python_version()
             ),
-        }
+            cls.step_setup_keyring(),
+            cls.step_protect_repository(),
+            cls.step_run_pre_commit_hooks(),
+        ]
+
+    @classmethod
+    def steps_aggregate_matrix_results(cls) -> list[dict[str, Any]]:
+        """Get the aggregate matrix results step."""
+        return [
+            cls.step_aggregate_matrix_results(),
+        ]

winipedia_utils/git/github/workflows/publish.py

@@ -19,31 +19,33 @@ class PublishWorkflow(Workflow):
     @classmethod
     def get_workflow_triggers(cls) -> dict[str, Any]:
         """Get the workflow triggers."""
-        return {
-            "workflow_run": {
-                "workflows": [ReleaseWorkflow.get_workflow_name()],
-                "types": ["completed"],
-            },
-        }
-
-    @classmethod
-    def get_permissions(cls) -> dict[str, Any]:
-        """Get the workflow permissions."""
-        return {
-            "contents": "read",
-        }
+        triggers = super().get_workflow_triggers()
+        triggers.update(
+            cls.on_workflow_run(workflows=[ReleaseWorkflow.get_workflow_name()])
+        )
+        return triggers
 
     @classmethod
     def get_jobs(cls) -> dict[str, Any]:
         """Get the workflow jobs."""
-        return cls.get_standard_job(
-            steps=[
-                *(
-                    cls.get_poetry_setup_steps(
-                        configure_pipy_token=True,
-                    )
-                ),
-                cls.get_publish_to_pypi_step(),
-            ],
-            if_condition="${{ github.event.workflow_run.conclusion == 'success' }}",
+        jobs: dict[str, Any] = {}
+        jobs.update(cls.job_publish())
+        return jobs
+
+    @classmethod
+    def job_publish(cls) -> dict[str, Any]:
+        """Get the publish job."""
+        return cls.get_job(
+            job_func=cls.job_publish,
+            steps=cls.steps_publish(),
+            if_condition=cls.if_workflow_run_is_success(),
         )
+
+    @classmethod
+    def steps_publish(cls) -> list[dict[str, Any]]:
+        """Get the publish steps."""
+        return [
+            *cls.steps_core_setup(),
+            cls.step_add_pypi_token_to_poetry(),
+            cls.step_publish_to_pypi(),
+        ]

winipedia_utils/git/github/workflows/release.py

@@ -3,13 +3,10 @@
 This workflow is used to create a release on GitHub.
 """
 
-from typing import TYPE_CHECKING, Any
+from typing import Any
 
 from winipedia_utils.git.github.workflows.health_check import HealthCheckWorkflow
 
-if TYPE_CHECKING:
-    from winipedia_utils.git.github.workflows.base.base import Workflow
-
 
 class ReleaseWorkflow(HealthCheckWorkflow):
     """Release workflow.
@@ -22,16 +19,10 @@ class ReleaseWorkflow(HealthCheckWorkflow):
     @classmethod
     def get_workflow_triggers(cls) -> dict[str, Any]:
         """Get the workflow triggers."""
-        return {
-            "push": {"branches": ["main"]},
-            "workflow_dispatch": {},
-            "schedule": [
-                {
-                    # run every Tuesday at 6 am
-                    "cron": "0 6 * * 2",
-                },
-            ],
-        }
+        triggers = super().get_workflow_triggers()
+        triggers.update(cls.on_push())
+        triggers.update(cls.on_schedule(cron="0 6 * * 2"))
+        return triggers
 
     @classmethod
     def get_permissions(cls) -> dict[str, Any]:
@@ -43,13 +34,58 @@ class ReleaseWorkflow(HealthCheckWorkflow):
     @classmethod
     def get_jobs(cls) -> dict[str, Any]:
         """Get the workflow jobs."""
-        parent_cls: type[Workflow] = cls.__bases__[0]
-        jobs = parent_cls.get_jobs()
-        release_job = cls.get_standard_job(
-            needs=[parent_cls.get_filename()],
-            steps=[
-                *cls.get_release_steps(),
-            ],
-        )
-        jobs.update(release_job)
+        jobs = super().get_jobs()
+        last_job_name = list(jobs.keys())[-1]
+        jobs.update(cls.job_build(needs=[last_job_name]))
+        jobs.update(cls.job_release())
         return jobs
+
+    @classmethod
+    def job_build(cls, needs: list[str] | None = None) -> dict[str, Any]:
+        """Get the build job."""
+        return cls.get_job(
+            job_func=cls.job_build,
+            needs=needs,
+            strategy=cls.strategy_matrix_os(),
+            runs_on=cls.insert_matrix_os(),
+            steps=cls.steps_build(),
+        )
+
+    @classmethod
+    def job_release(cls) -> dict[str, Any]:
+        """Get the release job."""
+        return cls.get_job(
+            job_func=cls.job_release,
+            needs=[cls.make_id_from_func(cls.job_build)],
+            steps=cls.steps_release(),
+        )
+
+    @classmethod
+    def steps_build(cls) -> list[dict[str, Any]]:
+        """Get the build steps."""
+        if not cls.BUILD_SCRIPT_PATH.exists():
+            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(),
+        ]
+
+    @classmethod
+    def steps_release(cls) -> list[dict[str, Any]]:
+        """Get the release steps."""
+        return [
+            *cls.steps_core_setup(repo_token=True),
+            cls.step_install_python_dependencies(),
+            cls.step_setup_git(),
+            cls.step_setup_keyring(),
+            cls.step_run_pre_commit_hooks(),
+            cls.step_commit_added_changes(),
+            cls.step_push_commits(),
+            cls.step_create_and_push_tag(),
+            cls.step_extract_version(),
+            cls.step_download_artifacts(),
+            cls.step_build_changelog(),
+            cls.step_create_release(),
+        ]

winipedia_utils/git/pre_commit/config.py

@@ -5,9 +5,9 @@ from typing import Any
 
 import winipedia_utils
 from winipedia_utils.logging.logger import get_logger
-from winipedia_utils.modules.package import make_name_from_package
 from winipedia_utils.os.os import run_subprocess
 from winipedia_utils.text.config import YamlConfigFile
+from winipedia_utils.text.string import make_name_from_obj
 
 logger = get_logger(__name__)
 
@@ -29,7 +29,7 @@ class PreCommitConfigConfigFile(YamlConfigFile):
     @classmethod
     def get_configs(cls) -> dict[str, Any]:
         """Get the config."""
-        hook_name = make_name_from_package(winipedia_utils, capitalize=False)
+        hook_name = make_name_from_obj(winipedia_utils, capitalize=False)
         return {
             "repos": [
                 {

winipedia_utils/modules/package.py

@@ -409,33 +409,6 @@ def get_main_package() -> ModuleType:
     raise ValueError(msg)
 
 
-def make_name_from_package(
-    package: ModuleType,
-    split_on: str = "_",
-    join_on: str = "-",
-    *,
-    capitalize: bool = True,
-) -> str:
-    """Make a name from a package.
-
-    takes a package and makes a name from it that is readable by humans.
-
-    Args:
-        package (ModuleType): The package to make a name from
-        split_on (str, optional): what to split the package name on. Defaults to "_".
-        join_on (str, optional): what to join the package name with. Defaults to "-".
-        capitalize (bool, optional): Whether to capitalize each part. Defaults to True.
-
-    Returns:
-        str: _description_
-    """
-    package_name = package.__name__.split(".")[-1]
-    parts = package_name.split(split_on)
-    if capitalize:
-        parts = [part.capitalize() for part in parts]
-    return join_on.join(parts)
-
-
 class DependencyGraph(nx.DiGraph):  # type: ignore [type-arg]
     """A directed graph representing Python package dependencies."""
 

winipedia_utils/projects/poetry/config.py

@@ -7,11 +7,12 @@ from typing import Any, cast
 import requests
 from packaging.version import Version
 
-from winipedia_utils.modules.package import get_src_package, make_name_from_package
+from winipedia_utils.modules.package import get_src_package
 from winipedia_utils.projects.poetry.poetry import VersionConstraint
 from winipedia_utils.testing.config import ExperimentConfigFile
 from winipedia_utils.testing.convention import TESTS_PACKAGE_NAME
 from winipedia_utils.text.config import ConfigFile, TomlConfigFile
+from winipedia_utils.text.string import make_name_from_obj
 
 
 class PyprojectConfigFile(TomlConfigFile):
@@ -27,7 +28,7 @@ class PyprojectConfigFile(TomlConfigFile):
         """Get the config."""
         return {
             "project": {
-                "name": make_name_from_package(get_src_package(), capitalize=False),
+                "name": make_name_from_obj(get_src_package(), capitalize=False),
                 "readme": "README.md",
                 "dynamic": ["dependencies"],
             },

winipedia_utils/text/string.py

@@ -7,7 +7,10 @@ These utilities simplify common string manipulation tasks throughout the applica
 
 import hashlib
 import textwrap
+from collections.abc import Callable
 from io import StringIO
+from types import ModuleType
+from typing import Any
 
 from defusedxml import ElementTree as DefusedElementTree
 
@@ -124,3 +127,30 @@ def split_on_uppercase(string: str) -> list[str]:
             current_part += letter
     parts.append(current_part)
     return parts
+
+
+def make_name_from_obj(
+    package: ModuleType | Callable[..., Any] | type,
+    split_on: str = "_",
+    join_on: str = "-",
+    *,
+    capitalize: bool = True,
+) -> str:
+    """Make a name from a package.
+
+    takes a package and makes a name from it that is readable by humans.
+
+    Args:
+        package (ModuleType): The package to make a name from
+        split_on (str, optional): what to split the package name on. Defaults to "_".
+        join_on (str, optional): what to join the package name with. Defaults to "-".
+        capitalize (bool, optional): Whether to capitalize each part. Defaults to True.
+
+    Returns:
+        str: _description_
+    """
+    package_name = package.__name__.split(".")[-1]
+    parts = package_name.split(split_on)
+    if capitalize:
+        parts = [part.capitalize() for part in parts]
+    return join_on.join(parts)

{winipedia_utils-0.5.22.dist-info → winipedia_utils-0.5.30.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.5.22
+Version: 0.5.30
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE
@@ -136,7 +136,7 @@ The health check workflow consists of two jobs:
    - Add Poetry to PATH (Windows-specific step)
    - Install dependencies
    - Setup CI keyring
-   - Protect repository (applies branch protection rules)
+   - Protect repository (applies branch protection rules and repository settings)
    - Run pre-commit hooks (linting, formatting, type checking, security, tests)
 
 2. **Aggregation Job** (`health_check`) - Aggregates matrix results into a single status check:
@@ -145,6 +145,7 @@ The health check workflow consists of two jobs:
    - Provides a single status check that can be marked as required in branch protection rules
 
 The release workflow extends the health check workflow and adds a release job that runs after all health checks pass.
+A build job is added before the release job if a script src/artifacts/build.py exists. This script is created by the setup command and can be modified to create build artifacts for your project. This script then just needs to create artifacts in a folder called artifacts and those will be uploaded as artifacts to the release.
 
 ### Pre-commit Hook Workflow
 

{winipedia_utils-0.5.22.dist-info → winipedia_utils-0.5.30.dist-info}/RECORD

@@ -1,4 +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/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
@@ -16,15 +18,15 @@ winipedia_utils/git/github/repo/protect.py,sha256=nOVjb5GVinGIClp7k9_qqgKnAl_gk1
 winipedia_utils/git/github/repo/repo.py,sha256=OqoOfqDhe_Iik71dNqi4h3fGrMno33hSjk0bpNg3eZk,7865
 winipedia_utils/git/github/workflows/__init__.py,sha256=BPdntTwFEyBMJ6MyT7gddPHswvRdH9tsRtfK72VSV7Y,57
 winipedia_utils/git/github/workflows/base/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
-winipedia_utils/git/github/workflows/base/base.py,sha256=K8Lb19clzaw35YCXHFJ7BVKqeI8bkqDtA-4aSjxl9LM,12770
-winipedia_utils/git/github/workflows/health_check.py,sha256=rSz3cV5xEgMIV-SaAjKBonucS_xqz1-t9FUDUbctRy8,2523
-winipedia_utils/git/github/workflows/publish.py,sha256=TPbSp5QH2vVl55UdqE_kjf1HIkdubcgqWlkLjWFX5EA,1378
-winipedia_utils/git/github/workflows/release.py,sha256=Vg87t_R-K9Ae-xQuvmGYi1nFhYfzgNVLu25EogfJwMw,1598
+winipedia_utils/git/github/workflows/base/base.py,sha256=Z6V0V4lGQL0wHpxqz0yHCVPRfq-Ig2keHsRW5nrFbVI,27659
+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/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
 winipedia_utils/git/pre_commit/__init__.py,sha256=gFLVGQRmS6abgy5MfPQy_GZiF1_hGxuXtcOHX95WL-A,58
-winipedia_utils/git/pre_commit/config.py,sha256=6Qvb8hoSm7Dmt5KmHOGATuLGrQDWd2aRKtevWThePio,1834
+winipedia_utils/git/pre_commit/config.py,sha256=t0CETAbworS_1g3U4BijVsI1pzcArWTT2-WOexh8aVA,1822
 winipedia_utils/git/pre_commit/hooks.py,sha256=d88F9Sgik3K6-lJpTio38_vx_ujL64BQ767xeBHHojY,4130
 winipedia_utils/git/pre_commit/run_hooks.py,sha256=3D8LDkVZVBw6q4RM0KmqMiNc299rjIrtxoL0bLGP2MU,1817
 winipedia_utils/iterating/__init__.py,sha256=rlF9hzxbowq5yOfcXvOKOQdB-EQmfrislQpf659Zeu4,53
@@ -38,7 +40,7 @@ winipedia_utils/modules/class_.py,sha256=LhhDoXh664h1ILP2lfxlF6M95lFoFNJhsTozxCQ
 winipedia_utils/modules/function.py,sha256=CvMosbeL2wyAu5eT3vjAvArn9j7aUPh_X3fGoIzwWBk,3479
 winipedia_utils/modules/inspection.py,sha256=XPSJfLN6WnNmbXn-6z9D01cmqmPS-HrTPy6-B6C34tw,1821
 winipedia_utils/modules/module.py,sha256=spyg4yI46BLMyhCrSSXIUbY1fHFjcpmRCdKQRUJB7pQ,12792
-winipedia_utils/modules/package.py,sha256=6Wb8Pu-SgRWGmKM2r1nhU-yftE7USSKWAuHQn2jRXlg,18058
+winipedia_utils/modules/package.py,sha256=QJLejQDJx2dJS4J75NRQD9jwUjUhLAAUQBBym772c20,17221
 winipedia_utils/oop/__init__.py,sha256=wGjsVwLbTVEQWOfDJvN9nlvC-3NmAi8Doc2xIrm6e78,47
 winipedia_utils/oop/mixins/__init__.py,sha256=PDK-cJcdRUfDUCz36qQ5pmMW07G133WtN49OpmILGNI,54
 winipedia_utils/oop/mixins/meta.py,sha256=0G4CzzzCoeP1Eas3vWe-uxvB5n5ncyw7Wc-sI9zmEBc,11150
@@ -47,7 +49,7 @@ winipedia_utils/os/__init__.py,sha256=cBRq8hWhaWvYeC3cSBYL6Y70kM9COQWHj8vVxxSadI
 winipedia_utils/os/os.py,sha256=K_5FD1sC1h5aSdtqXAG0uq90sSweLYLkgkRPQS0Jfxg,1768
 winipedia_utils/projects/__init__.py,sha256=_iYHzUcTPmutpsExPDcMF9OQDgnz-kTSuWens9iP9bI,52
 winipedia_utils/projects/poetry/__init__.py,sha256=tbvV3wYd3H39hjjlKbF84Irj4hYgv1A7KWyXdCQzFro,59
-winipedia_utils/projects/poetry/config.py,sha256=D42eowQfkBCurmb-CenujFXudtt5j1joZk0kM29wujA,8570
+winipedia_utils/projects/poetry/config.py,sha256=4SwzeqTVcnpcfuy1VSA9k2883xHJmJRS-xmbrS89Mfs,8601
 winipedia_utils/projects/poetry/poetry.py,sha256=e22_ltYXXF_y6UQbCwRX0NiQieyALkxDFfTLc2U9TSA,8478
 winipedia_utils/projects/project.py,sha256=rirg4xCIOTI6w7cLWufAVHAix7FGicvaCd9OnZQP8dA,521
 winipedia_utils/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
@@ -88,8 +90,8 @@ winipedia_utils/testing/tests/base/utils/utils.py,sha256=D7N-PW4N8853nJ2m4eYjO3j
 winipedia_utils/testing/tests/conftest.py,sha256=BLgUJtLecOwuEsIyJ__0buqovd5AhiGvbMNk8CHgSQs,888
 winipedia_utils/text/__init__.py,sha256=j2bwtK6kyeHI6SnoBjpRju0C1W2n2paXBDlNjNtaUxA,48
 winipedia_utils/text/config.py,sha256=jjKmn-tSbyaK6jGL0FxFHSREP6A6V1ZSX3RuIgvQ4io,7794
-winipedia_utils/text/string.py,sha256=yXmwOab5hXyVQG1NwlWDpy2prj0U7Vb2F5HKLT2Y77Q,3382
-winipedia_utils-0.5.22.dist-info/METADATA,sha256=TlNzrKGVw6pJ8rQkK6-buqMdC2Dg4ozPXxsEgssWNEU,16129
-winipedia_utils-0.5.22.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-winipedia_utils-0.5.22.dist-info/licenses/LICENSE,sha256=o316mE2gGzd__JT69p7S_zlOmKiHh8YjpImCCcWyTvM,1066
-winipedia_utils-0.5.22.dist-info/RECORD,,
+winipedia_utils/text/string.py,sha256=uHqpm1yXumiSDD7MZxfdkRS_4paQ5wIJweeBJK2bCdQ,4332
+winipedia_utils-0.5.30.dist-info/METADATA,sha256=9ehvXW41L9R4_F8sI96V3-1QBFlTxZRG2oAqxZ2L74I,16481
+winipedia_utils-0.5.30.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+winipedia_utils-0.5.30.dist-info/licenses/LICENSE,sha256=o316mE2gGzd__JT69p7S_zlOmKiHh8YjpImCCcWyTvM,1066
+winipedia_utils-0.5.30.dist-info/RECORD,,