winipedia-utils 0.3.24__tar.gz → 0.3.28__tar.gz

{winipedia_utils-0.3.24 → winipedia_utils-0.3.28}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.3.24
+Version: 0.3.28
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE
@@ -251,7 +251,6 @@ String manipulation and configuration file handling:
 
 ```python
 from winipedia_utils.text.string import value_to_truncated_string
-from winipedia_utils.text.config import ConfigFile
 ```
 
 ### OS and System Utilities
@@ -270,23 +269,6 @@ Utilities for working with iterables and nested structures:
 from winipedia_utils.iterating.iterate import get_len_with_default, nested_structure_is_subset
 ```
 
-### Git Utilities
-
-Git-related utilities including .gitignore handling and pre-commit hooks:
-
-```python
-from winipedia_utils.git.gitignore.gitignore import path_is_in_gitignore
-```
-
-### Project Management Utilities
-
-Tools for managing Poetry projects and project structure:
-
-```python
-from winipedia_utils.projects.project import create_project_root
-from winipedia_utils.projects.poetry.config import PyProjectTomlConfig
-```
-
 ### Philosophy
 
 The core philosophy of Winipedia Utils is to:

{winipedia_utils-0.3.24 → winipedia_utils-0.3.28}/README.md

@@ -227,7 +227,6 @@ String manipulation and configuration file handling:
 
 ```python
 from winipedia_utils.text.string import value_to_truncated_string
-from winipedia_utils.text.config import ConfigFile
 ```
 
 ### OS and System Utilities
@@ -246,23 +245,6 @@ Utilities for working with iterables and nested structures:
 from winipedia_utils.iterating.iterate import get_len_with_default, nested_structure_is_subset
 ```
 
-### Git Utilities
-
-Git-related utilities including .gitignore handling and pre-commit hooks:
-
-```python
-from winipedia_utils.git.gitignore.gitignore import path_is_in_gitignore
-```
-
-### Project Management Utilities
-
-Tools for managing Poetry projects and project structure:
-
-```python
-from winipedia_utils.projects.project import create_project_root
-from winipedia_utils.projects.poetry.config import PyProjectTomlConfig
-```
-
 ### Philosophy
 
 The core philosophy of Winipedia Utils is to:

{winipedia_utils-0.3.24 → winipedia_utils-0.3.28}/pyproject.toml

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

{winipedia_utils-0.3.24 → winipedia_utils-0.3.28}/winipedia_utils/git/workflows/base/base.py

@@ -1,6 +1,7 @@
 """Contains base utilities for git workflows."""
 
 from abc import abstractmethod
+from pathlib import Path
 from typing import Any
 
 from winipedia_utils.text.config import YamlConfigFile
@@ -22,6 +23,34 @@ class Workflow(YamlConfigFile):
     def get_jobs(self) -> dict[str, Any]:
         """Get the workflow jobs."""
 
+    def get_path(self) -> Path:
+        """Get the path to the config file."""
+        return (
+            Path(".github/workflows")
+            / f"{self.__class__.__name__.lower().removesuffix('workflow')}.yaml"
+        )
+
+    @staticmethod
+    def get_standard_job(
+        name: str,
+        steps: list[dict[str, Any]],
+        permissions: dict[str, Any] | None = None,
+        if_condition: str | None = None,
+    ) -> dict[str, Any]:
+        """Get a standard job."""
+        job: dict[str, Any] = {
+            name: {
+                "runs-on": "ubuntu-latest",
+                "steps": steps,
+            }
+        }
+        if permissions is not None:
+            job[name]["permissions"] = permissions
+
+        if if_condition is not None:
+            job[name]["if"] = if_condition
+        return job
+
     @classmethod
     def get_workflow_name(cls) -> str:
         """Get the workflow name."""
@@ -53,7 +82,7 @@ class Workflow(YamlConfigFile):
         """
         step: dict[str, Any] = {
             "name": "Checkout repository",
-            "uses": "actions/checkout@v5",
+            "uses": "actions/checkout@main",
         }
         if fetch_depth is not None:
             step["with"] = {"fetch-depth": fetch_depth}
@@ -93,7 +122,7 @@ class Workflow(YamlConfigFile):
         steps.append(
             {
                 "name": "Setup Python",
-                "uses": "actions/setup-python@v6",
+                "uses": "actions/setup-python@main",
                 "with": {"python-version": "3.x"},
             }
         )
@@ -121,6 +150,49 @@ class Workflow(YamlConfigFile):
             steps.append({"name": "Install Dependencies", "run": "poetry install"})
         return steps
 
+    @staticmethod
+    def get_release_steps() -> list[dict[str, Any]]:
+        """Get the release steps."""
+        return [
+            {
+                "name": "Create and Push Tag",
+                "run": f"git tag {Workflow.get_version()} && git push origin {Workflow.get_version()}",  # noqa: E501
+            },
+            {
+                "name": "Build Changelog",
+                "id": "build_changelog",
+                "uses": "mikepenz/release-changelog-builder-action@develop",
+                "with": {"token": "${{ secrets.GITHUB_TOKEN }}"},
+            },
+            {
+                "name": "Create GitHub Release",
+                "uses": "ncipollo/release-action@main",
+                "with": {
+                    "tag": Workflow.get_version(),
+                    "name": Workflow.get_repo_and_version(),
+                    "body": "${{ steps.build_changelog.outputs.changelog }}",
+                },
+            },
+        ]
+
+    @staticmethod
+    def get_publish_to_pypi_step() -> dict[str, Any]:
+        """Get the publish step."""
+        return {"name": "Build and publish to PyPI", "run": "poetry publish --build"}
+
+    @staticmethod
+    def get_pre_commit_step() -> dict[str, Any]:
+        """Get the pre-commit step.
+
+        using pre commit in case other hooks are added later
+        and bc it fails if files are changed,
+        setup script shouldnt change files
+        """
+        return {
+            "name": "Run Hooks",
+            "run": "poetry run pre-commit run --all-files --verbose",
+        }
+
     @staticmethod
     def get_repository_name() -> str:
         """Get the repository name."""

{winipedia_utils-0.3.24 → winipedia_utils-0.3.28}/winipedia_utils/git/workflows/publish.py

@@ -3,7 +3,6 @@
 This workflow is used to publish the package to PyPI with poetry.
 """
 
-from pathlib import Path
 from typing import Any
 
 from winipedia_utils.git.workflows.base.base import Workflow
@@ -11,13 +10,11 @@ from winipedia_utils.git.workflows.release import ReleaseWorkflow
 
 
 class PublishWorkflow(Workflow):
-    """Publish workflow."""
+    """Publish workflow.
 
-    PATH = Path(".github/workflows/publish.yaml")
-
-    def get_path(self) -> Path:
-        """Get the path to the config file."""
-        return self.PATH
+    This workflow is triggered by the release workflow.
+    It publishes the package to PyPI with poetry.
+    """
 
     def get_workflow_triggers(self) -> dict[str, Any]:
         """Get the workflow triggers."""
@@ -36,20 +33,15 @@ class PublishWorkflow(Workflow):
 
     def get_jobs(self) -> dict[str, Any]:
         """Get the workflow jobs."""
-        return {
-            "publish": {
-                "runs-on": "ubuntu-latest",
-                "if": "${{ github.event.workflow_run.conclusion == 'success' }}",
-                "steps": [
-                    *(
-                        self.get_poetry_setup_steps(
-                            configure_pipy_token=True,
-                        )
-                    ),
-                    {
-                        "name": "Build and publish to PyPI",
-                        "run": "poetry publish --build",
-                    },
-                ],
-            }
-        }
+        return self.get_standard_job(
+            "publish",
+            steps=[
+                *(
+                    self.get_poetry_setup_steps(
+                        configure_pipy_token=True,
+                    )
+                ),
+                self.get_publish_to_pypi_step(),
+            ],
+            if_condition="${{ github.event.workflow_run.conclusion == 'success' }}",
+        )

winipedia_utils-0.3.28/winipedia_utils/git/workflows/pullrequest.py

@@ -0,0 +1,44 @@
+"""Contains the pull request workflow.
+
+This workflow is used to run tests on pull requests.
+"""
+
+from typing import Any
+
+from winipedia_utils.git.workflows.base.base import Workflow
+
+
+class PullRequestWorkflow(Workflow):
+    """Pull request workflow.
+
+    This workflow is triggered by a pull request.
+    It runs tests on the pull request.
+    """
+
+    def get_workflow_triggers(self) -> dict[str, Any]:
+        """Get the workflow triggers."""
+        return {
+            "pull_request": {
+                "types": ["opened", "synchronize", "reopened"],
+            },
+        }
+
+    def get_permissions(self) -> dict[str, Any]:
+        """Get the workflow permissions."""
+        return {
+            "contents": "read",
+        }
+
+    def get_jobs(self) -> dict[str, Any]:
+        """Get the workflow jobs."""
+        return self.get_standard_job(
+            "check pull request",
+            steps=[
+                *(
+                    self.get_poetry_setup_steps(
+                        install_dependencies=True,
+                    )
+                ),
+                self.get_pre_commit_step(),
+            ],
+        )

winipedia_utils-0.3.28/winipedia_utils/git/workflows/release.py

@@ -0,0 +1,43 @@
+"""Contains the release workflow.
+
+This workflow is used to create a release on GitHub.
+"""
+
+from typing import Any
+
+from winipedia_utils.git.workflows.base.base import Workflow
+
+
+class ReleaseWorkflow(Workflow):
+    """Release workflow.
+
+    This workflow is triggered by a push to the main branch.
+    It creates a tag for the release and builds a changelog.
+    With tag and changelog it creates a release on GitHub
+    """
+
+    def get_workflow_triggers(self) -> dict[str, Any]:
+        """Get the workflow triggers."""
+        return {"push": {"branches": ["main"]}}
+
+    def get_permissions(self) -> dict[str, Any]:
+        """Get the workflow permissions."""
+        return {
+            "contents": "write",
+        }
+
+    def get_jobs(self) -> dict[str, Any]:
+        """Get the workflow jobs."""
+        return self.get_standard_job(
+            "release",
+            steps=[
+                *(
+                    self.get_poetry_setup_steps(
+                        install_dependencies=True,
+                        fetch_depth=0,
+                    )
+                ),
+                self.get_pre_commit_step(),
+                *self.get_release_steps(),
+            ],
+        )

winipedia_utils-0.3.24/winipedia_utils/git/workflows/release.py

@@ -1,71 +0,0 @@
-"""Contains the release workflow.
-
-This workflow is used to create a release on GitHub.
-"""
-
-from pathlib import Path
-from typing import Any
-
-from winipedia_utils.git.workflows.base.base import Workflow
-
-
-class ReleaseWorkflow(Workflow):
-    """Release workflow."""
-
-    PATH = Path(".github/workflows/release.yaml")
-
-    def get_path(self) -> Path:
-        """Get the path to the config file."""
-        return self.PATH
-
-    def get_workflow_triggers(self) -> dict[str, Any]:
-        """Get the workflow triggers."""
-        return {"push": {"branches": ["main"]}}
-
-    def get_permissions(self) -> dict[str, Any]:
-        """Get the workflow permissions."""
-        return {
-            "contents": "write",
-        }
-
-    def get_jobs(self) -> dict[str, Any]:
-        """Get the workflow jobs."""
-        return {
-            "release": {
-                "runs-on": "ubuntu-latest",
-                "steps": [
-                    *(
-                        self.get_poetry_setup_steps(
-                            install_dependencies=True,
-                            fetch_depth=0,
-                        )
-                    ),
-                    {
-                        # using pre commit in case other hooks are added later
-                        # and bc it fails if files are changed,
-                        # setup script shouldnt change files
-                        "name": "Run Hooks",
-                        "run": "poetry run pre-commit run --all-files --verbose",
-                    },
-                    {
-                        "name": "Create and Push Tag",
-                        "run": f"git tag {self.get_version()} && git push origin {self.get_version()}",  # noqa: E501
-                    },
-                    {
-                        "name": "Build Changelog",
-                        "id": "build_changelog",
-                        "uses": "mikepenz/release-changelog-builder-action@v5",
-                        "with": {"token": "${{ secrets.GITHUB_TOKEN }}"},
-                    },
-                    {
-                        "name": "Create GitHub Release",
-                        "uses": "ncipollo/release-action@v1",
-                        "with": {
-                            "tag": self.get_version(),
-                            "name": self.get_repo_and_version(),
-                            "body": "${{ steps.build_changelog.outputs.changelog }}",
-                        },
-                    },
-                ],
-            }
-        }