pyrig 2.2.6__py3-none-any.whl

pyrig/dev/configs/licence.py

@@ -0,0 +1,112 @@
+"""Configuration management for LICENSE files.
+
+This module provides the LicenceConfigFile class for managing the
+project's LICENSE file. The file is created empty and users are
+expected to add their own license text.
+"""
+
+from datetime import UTC, datetime
+from pathlib import Path
+
+import requests
+
+from pyrig.dev.configs.base.base import TextConfigFile
+from pyrig.dev.utils.resources import return_resource_content_on_fetch_error
+from pyrig.src.git.git import get_repo_owner_and_name_from_git
+
+
+class LicenceConfigFile(TextConfigFile):
+    """Configuration file manager for LICENSE.
+
+    Creates an empty LICENSE file in the project root. Users should
+    add their preferred license text manually.
+    It defaults to the MIT license the file does not exist.
+    """
+
+    @classmethod
+    def get_filename(cls) -> str:
+        """Get the LICENSE filename.
+
+        Returns:
+            The string "LICENSE".
+        """
+        return "LICENSE"
+
+    @classmethod
+    def get_path(cls) -> Path:
+        """Get the path to the LICENSE file.
+
+        Returns:
+            Path to LICENSE in the project root.
+        """
+        return Path(cls.get_filename())
+
+    @classmethod
+    def get_parent_path(cls) -> Path:
+        """Get the project root directory.
+
+        Returns:
+            Path to the project root.
+        """
+        return Path()
+
+    @classmethod
+    def get_file_extension(cls) -> str:
+        """Get an empty file extension.
+
+        Returns:
+            Empty string (LICENSE has no extension).
+        """
+        return ""
+
+    @classmethod
+    def get_content_str(cls) -> str:
+        """Get the initial content (empty).
+
+        Returns:
+            Empty string.
+        """
+        return cls.get_mit_license_with_year_and_owner()
+
+    @classmethod
+    def is_correct(cls) -> bool:
+        """Check if the LICENSE file is valid.
+
+        Returns:
+            True if the file exists and is non-empty.
+        """
+        return super().is_correct() or (
+            cls.get_path().exists()
+            and bool(cls.get_path().read_text(encoding="utf-8").strip())
+        )
+
+    @classmethod
+    @return_resource_content_on_fetch_error(resource_name="MIT_LICENSE_TEMPLATE")
+    def get_mit_license(cls) -> str:
+        """Get the MIT license text.
+
+        Fetch the MIT license text from GitHub's SPDX license API.
+        On exception returns a default MIT license text.
+
+        Returns:
+            The MIT license text.
+        """
+        url = "https://api.github.com/licenses/mit"
+        resp = requests.get(url, timeout=10)
+        resp.raise_for_status()
+        data = resp.json()
+        mit_license: str = data["body"]
+        return mit_license
+
+    @classmethod
+    def get_mit_license_with_year_and_owner(cls) -> str:
+        """Get the MIT license text with year and owner.
+
+        Returns:
+            The MIT license text with year and owner.
+        """
+        mit_license = cls.get_mit_license()
+        year = datetime.now(tz=UTC).year
+        owner, _ = get_repo_owner_and_name_from_git(check_repo_url=False)
+        mit_license = mit_license.replace("[year]", str(year))
+        return mit_license.replace("[fullname]", owner)

pyrig/dev/configs/markdown/__init__.py

@@ -0,0 +1 @@
+"""__init__ module."""

pyrig/dev/configs/markdown/docs/__init__.py

@@ -0,0 +1 @@
+"""__init__ module."""

pyrig/dev/configs/markdown/docs/index.py

@@ -0,0 +1,38 @@
+"""Configuration management for docs/index.md files.
+
+This module provides the IndexConfigFile class for creating and
+managing the project's docs/index.md file with a standard header.
+"""
+
+from pathlib import Path
+
+from pyrig.dev.configs.base.base import MarkdownConfigFile
+from pyrig.dev.configs.pyproject import PyprojectConfigFile
+from pyrig.src.modules.package import DOCS_DIR_NAME
+
+
+class IndexConfigFile(MarkdownConfigFile):
+    """Configuration file manager for docs/index.md.
+
+    Creates a docs/index.md file with a standard header and
+    instructions for users to add their own content.
+    """
+
+    @classmethod
+    def get_parent_path(cls) -> Path:
+        """Get the docs directory path.
+
+        Returns:
+            Path to the docs directory.
+        """
+        return Path(DOCS_DIR_NAME)
+
+    @classmethod
+    def get_content_str(cls) -> str:
+        """Get the index file content.
+
+        Returns:
+            Markdown content with a standard header and instructions.
+        """
+        return f"""# {PyprojectConfigFile.get_project_name()} Documentation
+"""

pyrig/dev/configs/markdown/readme.py

@@ -0,0 +1,132 @@
+"""Configuration management for README.md files.
+
+This module provides the ReadmeConfigFile class for creating and
+managing the project's README.md file with a standard header.
+"""
+
+from pathlib import Path
+
+import pyrig
+from pyrig.dev.configs.base.base import MarkdownConfigFile
+from pyrig.dev.configs.pyproject import PyprojectConfigFile
+from pyrig.dev.utils.git import DEFAULT_BRANCH
+from pyrig.src.git.git import get_repo_owner_and_name_from_git
+
+
+class ReadmeConfigFile(MarkdownConfigFile):
+    """Configuration file manager for README.md.
+
+    Creates a README.md file with the project name as a header.
+    For projects using pyrig, includes a reference link to pyrig.
+    """
+
+    @classmethod
+    def get_filename(cls) -> str:
+        """Get the README filename.
+
+        Returns:
+            The string "README".
+        """
+        return "README"
+
+    @classmethod
+    def get_parent_path(cls) -> Path:
+        """Get the project root directory.
+
+        Returns:
+            Path to the project root.
+        """
+        return Path()
+
+    @classmethod
+    def get_content_str(cls) -> str:
+        """Generate the README content with project header.
+
+        Returns:
+            Markdown content with project name and optional pyrig reference.
+        """
+        project_name = PyprojectConfigFile.get_project_name()
+        badges = cls.get_badges()
+        badges_str = ""
+        for badge_category, badge_list in badges.items():
+            badges_str += f"<!-- {badge_category} -->\n"
+            badges_str += "\n".join(badge_list) + "\n"
+        badges_str = badges_str.removesuffix("\n")
+        description = PyprojectConfigFile.get_project_description()
+        return f"""# {project_name}
+
+{badges_str}
+
+---
+
+> {description}
+
+---
+"""
+
+    @classmethod
+    def is_unwanted(cls) -> bool:
+        """Check if README is unwanted (always False).
+
+        Returns:
+            False, as README.md is always required.
+        """
+        # README.md is never unwanted
+        return False
+
+    @classmethod
+    def is_correct(cls) -> bool:
+        """Check if the README.md file is valid.
+
+        Returns:
+            True if the file has required structure.
+        """
+        file_content = cls.get_file_content()
+        badges = [
+            badge for _group, badges in cls.get_badges().items() for badge in badges
+        ]
+        all_badges_in_file = all(badge in file_content for badge in badges)
+        description_in_file = (
+            PyprojectConfigFile.get_project_description() in file_content
+        )
+        project_name_in_file = PyprojectConfigFile.get_project_name() in file_content
+        return super().is_correct() or (
+            all_badges_in_file and description_in_file and project_name_in_file
+        )
+
+    @classmethod
+    def get_badges(cls) -> dict[str, list[str]]:
+        """Get the badges for the README.md file.
+
+        Returns:
+            List of badge markdown strings.
+        """
+        repo_owner, repo_name = get_repo_owner_and_name_from_git(check_repo_url=False)
+        project_name = PyprojectConfigFile.get_project_name()
+        python_versions = PyprojectConfigFile.get_supported_python_versions()
+        joined_python_versions = "|".join(str(v) for v in python_versions)
+        return {
+            "tooling": [
+                rf"[![{pyrig.__name__}](https://img.shields.io/badge/built%20with-{pyrig.__name__}-3776AB?logo=buildkite&logoColor=black)](https://github.com/Winipedia/{pyrig.__name__})",
+                r"[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)",
+                r"[![Container](https://img.shields.io/badge/Container-Podman-A23CD6?logo=podman&logoColor=grey&colorA=0D1F3F&colorB=A23CD6)](https://podman.io/)",
+                r"[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://pre-commit.com/)",
+            ],
+            "code-quality": [
+                r"[![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)",
+                r"[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)"
+                r"[![mypy](https://img.shields.io/badge/type%20checked-mypy-039dfc.svg)](https://mypy-lang.org/)",
+                r"[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)",
+                r"[![pytest](https://img.shields.io/badge/tested%20with-pytest-46a2f1.svg?logo=pytest)](https://pytest.org/)",
+                rf"[![codecov](https://codecov.io/gh/{repo_owner}/{repo_name}/branch/{DEFAULT_BRANCH}/graph/badge.svg)](https://codecov.io/gh/{repo_owner}/{repo_name})",
+            ],
+            "package-info": [
+                rf"[![PyPI](https://img.shields.io/pypi/v/{project_name}?logo=pypi&logoColor=white)](https://pypi.org/project/{project_name}/)",
+                rf"[![Python](https://img.shields.io/badge/python-{joined_python_versions}-blue.svg?logo=python&logoColor=white)](https://www.python.org/)",
+                rf"[![License](https://img.shields.io/github/license/{repo_owner}/{repo_name})](https://github.com/{repo_owner}/{repo_name}/blob/main/LICENSE)",
+            ],
+            "ci/cd": [
+                rf"[![CI](https://img.shields.io/github/actions/workflow/status/{repo_owner}/{repo_name}/health_check.yaml?label=CI&logo=github)](https://github.com/{repo_owner}/{repo_name}/actions/workflows/health_check.yaml)",
+                rf"[![CD](https://img.shields.io/github/actions/workflow/status/{repo_owner}/{repo_name}/release.yaml?label=CD&logo=github)](https://github.com/{repo_owner}/{repo_name}/actions/workflows/release.yaml)",
+            ],
+        }

pyrig/dev/configs/py_typed.py

@@ -0,0 +1,28 @@
+"""Configuration management for py.typed marker files.
+
+This module provides the PyTypedConfigFile class for creating the
+py.typed marker file that indicates PEP 561 compliance for type
+checkers like mypy.
+"""
+
+from pathlib import Path
+
+from pyrig.dev.configs.base.base import TypedConfigFile
+from pyrig.dev.configs.pyproject import PyprojectConfigFile
+
+
+class PyTypedConfigFile(TypedConfigFile):
+    """Configuration file manager for py.typed.
+
+    Creates the py.typed marker file in the source package to indicate
+    that the package supports type checking (PEP 561).
+    """
+
+    @classmethod
+    def get_parent_path(cls) -> Path:
+        """Get the source package directory.
+
+        Returns:
+            Path to the source package.
+        """
+        return Path(PyprojectConfigFile.get_package_name())