winipedia-utils 0.4.48__py3-none-any.whl → 0.4.53__py3-none-any.whl

winipedia_utils/git/github/workflows/base/base.py

@@ -2,7 +2,7 @@
 
 from abc import abstractmethod
 from pathlib import Path
-from typing import Any
+from typing import Any, ClassVar
 
 import winipedia_utils
 from winipedia_utils.modules.module import make_obj_importpath
@@ -15,6 +15,37 @@ from winipedia_utils.text.string import split_on_uppercase
 class Workflow(YamlConfigFile):
     """Base class for workflows."""
 
+    EMPTY_CONFIG: ClassVar[dict[str, Any]] = {
+        "on": {
+            "workflow_dispatch": {},
+        },
+        "jobs": {
+            "empty": {
+                "runs-on": "ubuntu-latest",
+                "steps": [
+                    {
+                        "name": "Empty Step",
+                        "run": "echo 'Empty Step'",
+                    }
+                ],
+            },
+        },
+    }
+
+    @classmethod
+    def is_correct(cls) -> bool:
+        """Check if the config is correct.
+
+        Needs some special handling since workflow files cannot be empty.
+        We need a workflow that will never trigger and even if doesnt do anything.
+        """
+        correct = super().is_correct()
+        if cls.get_path().read_text() == "":
+            # dump a dispatch in there for on and an empty job for jobs
+            cls.dump(cls.EMPTY_CONFIG)
+
+        return correct or cls.load() == cls.EMPTY_CONFIG
+
     @classmethod
     @abstractmethod
     def get_workflow_triggers(cls) -> dict[str, Any]:
@@ -113,7 +144,7 @@ class Workflow(YamlConfigFile):
         return step
 
     @classmethod
-    def get_poetry_setup_steps(
+    def get_poetry_setup_steps(  # noqa: PLR0913
         cls,
         *,
         install_dependencies: bool = False,
@@ -121,6 +152,7 @@ class Workflow(YamlConfigFile):
         configure_pipy_token: bool = False,
         force_main_head: bool = False,
         token: bool = False,
+        with_keyring: bool = False,
     ) -> list[dict[str, Any]]:
         """Get the poetry steps.
 
@@ -132,6 +164,7 @@ class Workflow(YamlConfigFile):
             equal to the most recent commit on main. This is useful for workflows that
             should only run on main.
         token: Whether to use the repository token.
+        with_keyring: Whether to setup the keyring.
 
         Returns:
         The poetry steps.
@@ -161,6 +194,7 @@ class Workflow(YamlConfigFile):
                 "run": "curl -sSL https://install.python-poetry.org | python3 -",
             }
         )
+
         if configure_pipy_token:
             steps.append(
                 {
@@ -168,8 +202,13 @@ class Workflow(YamlConfigFile):
                     "run": "poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}",
                 }
             )
+
         if install_dependencies:
             steps.append({"name": "Install Dependencies", "run": "poetry install"})
+
+        if with_keyring:
+            steps.append(cls.get_setup_keyring_step())
+
         return steps
 
     @classmethod
@@ -243,6 +282,14 @@ class Workflow(YamlConfigFile):
             "run": "git commit --no-verify -m '[skip ci] CI/CD: Committing possible added changes (e.g.: pyproject.toml and poetry.lock)'",  # noqa: E501
         }
 
+    @classmethod
+    def get_setup_keyring_step(cls) -> dict[str, Any]:
+        """Get the setup keyring step."""
+        return {
+            "name": "Setup CI keyring",
+            "run": """poetry run pip install keyrings.alt && poetry run python -c "import keyring; from keyrings.alt.file import PlaintextKeyring; keyring.set_keyring(PlaintextKeyring()); keyring.set_password('video_vault','ci_user','ci-secret-token'); print('Keyring OK:', keyring.get_password('video_vault','ci_user'))" """,  # noqa: E501
+        }
+
     @classmethod
     def get_protect_repository_step(cls) -> dict[str, Any]:
         """Get the protect repository step."""

winipedia_utils/git/github/workflows/health_check.py

@@ -46,6 +46,7 @@ class HealthCheckWorkflow(Workflow):
                         cls.get_poetry_setup_steps(
                             install_dependencies=True,
                             token=True,
+                            with_keyring=True,
                         )
                     ),
                     cls.get_protect_repository_step(),

{winipedia_utils-0.4.48.dist-info → winipedia_utils-0.4.53.dist-info}/METADATA

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

{winipedia_utils-0.4.48.dist-info → winipedia_utils-0.4.53.dist-info}/RECORD

@@ -16,8 +16,8 @@ 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=t2jYHVpvhCaKpaZI9Yhr8YJEp-2D_G4VUJKVVYIUolc,9749
-winipedia_utils/git/github/workflows/health_check.py,sha256=cPjSJxNy9h0bKNK69crmcERACx4VGR2XytyZ1JM_wMQ,1567
+winipedia_utils/git/github/workflows/base/base.py,sha256=4MAHU_oPqicwO7tZE0B99RK9ZKRMFIZhUYkWr1NrYqo,11405
+winipedia_utils/git/github/workflows/health_check.py,sha256=pjGZckvfPHuR6QepHia6_FKcwUQAXuhGGVaVCpLQNaY,1614
 winipedia_utils/git/github/workflows/publish.py,sha256=TPbSp5QH2vVl55UdqE_kjf1HIkdubcgqWlkLjWFX5EA,1378
 winipedia_utils/git/github/workflows/release.py,sha256=hnMT12J17LmFpPCTzva-lW95MOFDQ-1bAOrTVCxeaR8,1301
 winipedia_utils/git/gitignore/__init__.py,sha256=k-2E26JaZPkF69UUOJkpQl8T_PudrC7EYCIOxwgIQVU,57
@@ -88,7 +88,7 @@ winipedia_utils/testing/tests/conftest.py,sha256=BLgUJtLecOwuEsIyJ__0buqovd5AhiG
 winipedia_utils/text/__init__.py,sha256=j2bwtK6kyeHI6SnoBjpRju0C1W2n2paXBDlNjNtaUxA,48
 winipedia_utils/text/config.py,sha256=BPpuD4ywzzzt6Jz2M5Eln5d1NLlDp4r7CPwQOgHkxcg,7782
 winipedia_utils/text/string.py,sha256=yXmwOab5hXyVQG1NwlWDpy2prj0U7Vb2F5HKLT2Y77Q,3382
-winipedia_utils-0.4.48.dist-info/METADATA,sha256=Cpe2X9GV4-qJUvJhHg7ipY7gweMTuBn8rt2azARZm-8,14694
-winipedia_utils-0.4.48.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-winipedia_utils-0.4.48.dist-info/licenses/LICENSE,sha256=o316mE2gGzd__JT69p7S_zlOmKiHh8YjpImCCcWyTvM,1066
-winipedia_utils-0.4.48.dist-info/RECORD,,
+winipedia_utils-0.4.53.dist-info/METADATA,sha256=dHVCIWf2JB02S9ZNLS0WWKMjr_oH6kgudHrU682IrZo,14694
+winipedia_utils-0.4.53.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+winipedia_utils-0.4.53.dist-info/licenses/LICENSE,sha256=o316mE2gGzd__JT69p7S_zlOmKiHh8YjpImCCcWyTvM,1066
+winipedia_utils-0.4.53.dist-info/RECORD,,