pyrig 2.2.6__py3-none-any.whl

pyrig/dev/utils/versions.py

@@ -0,0 +1,268 @@
+"""Version parsing and constraint utilities.
+
+This module provides utilities for working with Python version specifiers
+and constraints. It wraps the `packaging` library to provide convenient
+methods for extracting version bounds and generating version ranges.
+
+The main class `VersionConstraint` parses PEP 440 version specifiers
+(e.g., ">=3.8,<3.12") and provides methods to:
+    - Get inclusive/exclusive lower and upper bounds
+    - Generate lists of versions within a constraint
+    - Adjust version precision (major/minor/micro)
+
+Example:
+    >>> from pyrig.src.project.versions import VersionConstraint
+    >>> vc = VersionConstraint(">=3.8,<3.12")
+    >>> vc.get_lower_inclusive()
+    <Version('3.8')>
+    >>> vc.get_version_range(level="minor")
+    [<Version('3.8')>, <Version('3.9')>, <Version('3.10')>, <Version('3.11')>]
+"""
+
+from typing import Literal
+
+from packaging.specifiers import SpecifierSet
+from packaging.version import Version
+
+
+def adjust_version_to_level(
+    version: Version, level: Literal["major", "minor", "micro"]
+) -> Version:
+    """Truncate a version to the specified precision level.
+
+    Args:
+        version: The version to adjust.
+        level: The precision level to truncate to.
+
+    Returns:
+        A new Version with components beyond the level removed.
+
+    Example:
+        >>> adjust_version_to_level(Version("3.11.5"), "minor")
+        <Version('3.11')>
+    """
+    if level == "major":
+        return Version(f"{version.major}")
+    if level == "minor":
+        return Version(f"{version.major}.{version.minor}")
+    return version
+
+
+class VersionConstraint:
+    """Parser and analyzer for PEP 440 version constraints.
+
+    Parses version specifier strings (e.g., ">=3.8,<3.12") and provides
+    methods to extract bounds and generate version ranges. Handles both
+    inclusive and exclusive bounds, converting between them as needed.
+
+    Attributes:
+        constraint: The original constraint string.
+        spec: The cleaned specifier string (quotes stripped).
+        sset: The parsed SpecifierSet from the packaging library.
+        lower_inclusive: The effective lower bound (inclusive).
+        upper_exclusive: The effective upper bound (exclusive).
+
+    Example:
+        >>> vc = VersionConstraint(">=3.8,<3.12")
+        >>> vc.get_lower_inclusive()
+        <Version('3.8')>
+        >>> vc.get_upper_exclusive()
+        <Version('3.12')>
+    """
+
+    def __init__(self, constraint: str) -> None:
+        """Initialize a VersionConstraint from a specifier string.
+
+        Args:
+            constraint: A PEP 440 version specifier string (e.g., ">=3.8,<3.12").
+        """
+        self.constraint = constraint
+        self.spec = self.constraint.strip().strip('"').strip("'")
+        self.sset = SpecifierSet(self.spec)
+
+        self.lowers_inclusive = [
+            Version(s.version) for s in self.sset if s.operator == ">="
+        ]
+        self.lowers_exclusive = [
+            Version(s.version) for s in self.sset if s.operator == ">"
+        ]
+        # increment the last number of exclusive, so
+        # >3.4.1 to >=3.4.2; <3.4.0 to <=3.4.1; 3.0.0 to <=3.0.1
+        self.lowers_exclusive_to_inclusive = [
+            Version(f"{v.major}.{v.minor}.{v.micro + 1}") for v in self.lowers_exclusive
+        ]
+        self.lowers_inclusive = (
+            self.lowers_inclusive + self.lowers_exclusive_to_inclusive
+        )
+
+        self.uppers_inclusive = [
+            Version(s.version) for s in self.sset if s.operator == "<="
+        ]
+        self.uppers_exclusive = [
+            Version(s.version) for s in self.sset if s.operator == "<"
+        ]
+
+        # increment the last number of inclusive, so
+        # <=3.4.1 to <3.4.2; >=3.4.0 to >3.4.1; 3.0.0 to >3.0.1
+        self.uppers_inclusive_to_exclusive = [
+            Version(f"{v.major}.{v.minor}.{v.micro + 1}") for v in self.uppers_inclusive
+        ]
+        self.uppers_exclusive = (
+            self.uppers_inclusive_to_exclusive + self.uppers_exclusive
+        )
+
+        self.upper_exclusive = (
+            min(self.uppers_exclusive) if self.uppers_exclusive else None
+        )
+        self.lower_inclusive = (
+            max(self.lowers_inclusive) if self.lowers_inclusive else None
+        )
+
+    def get_lower_inclusive(
+        self, default: str | Version | None = None
+    ) -> Version | None:
+        """Get the minimum version.
+
+        Is given inclusive. E.g. >=3.8, <3.12 -> 3.8
+        if >3.7, <3.12 -> 3.7.1
+
+        E.g. >=3.8, <3.12 -> 3.8
+
+        Args:
+            default: The default value to return if there is no minimum version
+
+        Returns:
+            The minimum version
+        """
+        default = str(default) if default else None
+        if self.lower_inclusive is None:
+            return Version(default) if default else None
+
+        return self.lower_inclusive
+
+    def get_upper_exclusive(
+        self, default: str | Version | None = None
+    ) -> Version | None:
+        """Get the maximum version.
+
+        Is given exclusive. E.g. >=3.8, <3.12 -> 3.12
+        if >=3.8, <=3.12 -> 3.12.1
+
+        Args:
+            default: The default value to return if there is no maximum version
+
+        Returns:
+            The maximum version
+        """
+        default = str(default) if default else None
+        if self.upper_exclusive is None:
+            return Version(default) if default else None
+
+        return self.upper_exclusive
+
+    def get_upper_inclusive(
+        self, default: str | Version | None = None
+    ) -> Version | None:
+        """Get the maximum version.
+
+        Is given inclusive. E.g. >=3.8, <3.12 -> 3.11
+        if >=3.8, <=3.12 -> 3.12
+
+        Args:
+            default: The default value to return if there is no maximum version
+
+        Returns:
+            The maximum version
+        """
+        # increment the default by 1 micro to make it exclusive
+        if default:
+            default = Version(str(default))
+            default = Version(f"{default.major}.{default.minor}.{default.micro + 1}")
+        upper_exclusive = self.get_upper_exclusive(default)
+        if upper_exclusive is None:
+            return None
+
+        if upper_exclusive.micro != 0:
+            return Version(
+                f"{upper_exclusive.major}.{upper_exclusive.minor}.{upper_exclusive.micro - 1}"  # noqa: E501
+            )
+        if upper_exclusive.minor != 0:
+            return Version(f"{upper_exclusive.major}.{upper_exclusive.minor - 1}")
+        return Version(f"{upper_exclusive.major - 1}")
+
+    def get_version_range(
+        self,
+        level: Literal["major", "minor", "micro"] = "major",
+        lower_default: str | Version | None = None,
+        upper_default: str | Version | None = None,
+    ) -> list[Version]:
+        """Get the version range.
+
+        returns a range of versions according to the level
+
+        E.g. >=3.8, <3.12; level=major -> 3
+            >=3.8, <4.12; level=major -> 3, 4
+        E.g. >=3.8, <=3.12; level=minor -> 3.8, 3.9, 3.10, 3.11, 3.12
+        E.g. >=3.8.1, <=4.12.1; level=micro -> 3.8.1, 3.8.2, ... 4.12.1
+
+        Args:
+            level: The level of the version to return
+            lower_default: The default lower bound if none is specified
+            upper_default: The default upper bound if none is specified
+
+        Returns:
+            A list of versions
+        """
+        lower = self.get_lower_inclusive(lower_default)
+        upper = self.get_upper_inclusive(upper_default)
+
+        if lower is None or upper is None:
+            msg = "No lower or upper bound. Please specify default values."
+            raise ValueError(msg)
+
+        major_level, minor_level, micro_level = range(3)
+        level_int = {"major": major_level, "minor": minor_level, "micro": micro_level}[
+            level
+        ]
+        lower_as_list = [lower.major, lower.minor, lower.micro]
+        upper_as_list = [upper.major, upper.minor, upper.micro]
+
+        versions: list[list[int]] = []
+        for major in range(lower_as_list[major_level], upper_as_list[major_level] + 1):
+            version = [major]
+
+            minor_lower_og, minor_upper_og = (
+                lower_as_list[minor_level],
+                upper_as_list[minor_level],
+            )
+            diff = minor_upper_og - minor_lower_og
+            minor_lower = minor_lower_og if diff >= 0 else 0
+            minor_upper = minor_upper_og if diff >= 0 else minor_lower_og + abs(diff)
+            for minor in range(
+                minor_lower,
+                minor_upper + 1,
+            ):
+                # pop the minor if one already exists
+                if len(version) > minor_level:
+                    version.pop()
+
+                version.append(minor)
+
+                micro_lower_og, micro_upper_og = (
+                    lower_as_list[micro_level],
+                    upper_as_list[micro_level],
+                )
+                diff = micro_upper_og - micro_lower_og
+                micro_lower = micro_lower_og if diff >= 0 else 0
+                micro_upper = (
+                    micro_upper_og if diff >= 0 else micro_lower_og + abs(diff)
+                )
+                for micro in range(
+                    micro_lower,
+                    micro_upper + 1,
+                ):
+                    version.append(micro)
+                    versions.append(version[: level_int + 1])
+                    version.pop()
+        version_versions = sorted({Version(".".join(map(str, v))) for v in versions})
+        return [v for v in version_versions if self.sset.contains(v)]

pyrig/main.py

@@ -0,0 +1,9 @@
+"""Main entrypoint for the project."""
+
+
+def main() -> None:
+    """Main entrypoint for the project."""
+
+
+if __name__ == "__main__":
+    main()

pyrig/resources/GITIGNORE

@@ -0,0 +1,216 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

pyrig/resources/LATEST_PYTHON_VERSION

@@ -0,0 +1 @@
+3.14.2

pyrig/resources/MIT_LICENSE_TEMPLATE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyrig/resources/__init__.py

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

pyrig/src/__init__.py

@@ -0,0 +1 @@
+"""src package."""

pyrig/src/git/__init__.py

@@ -0,0 +1,6 @@
+"""Git and GitHub integration utilities.
+
+This package provides utilities for interacting with Git repositories and
+the GitHub API, including repository information extraction and GitHub
+Actions detection.
+"""

pyrig/src/git/git.py

@@ -0,0 +1,146 @@
+"""GitHub repository utilities for token management and URL parsing.
+
+This module provides utilities for working with GitHub repositories,
+including authentication token retrieval, GitHub Actions environment
+detection, and repository URL parsing.
+
+The token retrieval supports both environment variables and .env files,
+following a priority order that prefers environment variables for CI/CD
+compatibility.
+
+Example:
+    >>> from pyrig.src.git.github.github import get_repo_owner_and_name_from_git
+    >>> owner, repo = get_repo_owner_and_name_from_git()
+    >>> print(f"{owner}/{repo}")
+    myorg/myrepo
+"""
+
+import os
+from pathlib import Path
+from subprocess import CompletedProcess  # nosec: B404
+
+from pyrig.src.modules.package import get_project_name_from_cwd
+from pyrig.src.os.os import run_subprocess
+
+
+def running_in_github_actions() -> bool:
+    """Check if the code is running inside a GitHub Actions workflow.
+
+    GitHub Actions sets the `GITHUB_ACTIONS` environment variable to "true"
+    in all workflow runs. This function checks for that variable.
+
+    Returns:
+        True if running in GitHub Actions, False otherwise.
+
+    Example:
+        >>> if running_in_github_actions():
+        ...     print("Running in CI")
+        ... else:
+        ...     print("Running locally")
+    """
+    return os.getenv("GITHUB_ACTIONS", "false") == "true"
+
+
+def get_repo_url_from_git(*, check: bool = True) -> str:
+    """Get the remote origin URL from the local git repository.
+
+    Executes `git config --get remote.origin.url` to retrieve the URL
+    of the origin remote.
+    Url can be:
+        - https://github.com/owner/repo.git
+        - git@github.com:owner/repo.git
+
+    Args:
+        check: Whether to check succes in subprocess.
+
+    Returns:
+        The remote origin URL (e.g., "https://github.com/owner/repo.git"
+        or "git@github.com:owner/repo.git").
+
+    Raises:
+        subprocess.CalledProcessError: If not in a git repository or if
+            the origin remote is not configured.
+    """
+    stdout: str = run_subprocess(
+        ["git", "config", "--get", "remote.origin.url"], check=check
+    ).stdout.decode("utf-8")
+    return stdout.strip()
+
+
+def get_git_username() -> str:
+    """Get the git username from the local git config.
+
+    Executes `git config --get user.name` to retrieve the username.
+
+    Returns:
+        The git username.
+
+    Raises:
+        subprocess.CalledProcessError: If the username cannot be read.
+    """
+    stdout: str = run_subprocess(["git", "config", "--get", "user.name"]).stdout.decode(
+        "utf-8"
+    )
+    return stdout.strip()
+
+
+def get_repo_owner_and_name_from_git(*, check_repo_url: bool = True) -> tuple[str, str]:
+    """Extract the GitHub owner and repository name from the git remote.
+
+    Parses the remote origin URL to extract the owner (organization or user)
+    and repository name. Handles both HTTPS and SSH URL formats.
+
+    Args:
+        check_repo_url: Whether to check succes in subprocess.
+
+    Returns:
+        A tuple of (owner, repository_name).
+
+    Raises:
+        subprocess.CalledProcessError: If the git remote cannot be read.
+
+    Example:
+        >>> owner, repo = get_repo_owner_and_name_from_git()
+        >>> print(f"{owner}/{repo}")
+        myorg/myrepo
+    """
+    url = get_repo_url_from_git(check=check_repo_url)
+    if not url:
+        # we default to git username and repo name from cwd
+        owner = get_git_username()
+        repo = get_project_name_from_cwd()
+        return owner, repo
+
+    parts = url.removesuffix(".git").split("/")
+    # keep last two parts
+    owner, repo = parts[-2:]
+    if ":" in owner:
+        owner = owner.split(":")[-1]
+    return owner, repo
+
+
+def get_git_unstaged_changes() -> str:
+    """Check if the git repository has uncommitted changes.
+
+    Returns:
+        The output of git diff
+    """
+    completed_process = run_subprocess(["git", "diff"])
+    unstaged_changes: str = completed_process.stdout.decode("utf-8")
+    return unstaged_changes
+
+
+def git_add_file(path: Path, *, check: bool = True) -> CompletedProcess[bytes]:
+    """Add a file to the git index.
+
+    Args:
+        path: Path to the file to add.
+        check: Whether to check succes in subprocess.
+
+    Returns:
+        The completed process result.
+    """
+    # make path relative to cwd if it is absolute
+    if path.is_absolute():
+        path = path.relative_to(Path.cwd())
+    return run_subprocess(["git", "add", str(path)], check=check)