Skip to content

API Reference

Pyrig-specific overrides for pyrig's own configuration and tooling.

rig

Mirrored layer of overrides for pyrig's own configuration and tool definitions.

configs

Pyrig-specific overrides for managed configuration file definitions.

Extends the configuration definitions this package inherits from its dependencies with metadata and settings specific to publishing pyrig itself.

pyproject

Pyrig-specific pyproject.toml configuration overrides.

Extends the base pyproject.toml configuration with PyPI classifiers and keywords relevant to pyrig's purpose as a project scaffolding and automation toolkit.

PyprojectConfigFile

Bases: PyprojectConfigFile

Pyrig-specific pyproject.toml configuration.

Adds PyPI metadata specific to pyrig: development status, intended audience, topic classifiers, and project-related keywords for package discovery.

Source code in src/pyrig_overrides/rig/configs/pyproject.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
class PyprojectConfigFile(BasePyprojectConfigFile):
    """Pyrig-specific pyproject.toml configuration.

    Adds PyPI metadata specific to pyrig: development status, intended
    audience, topic classifiers, and project-related keywords for package
    discovery.
    """

    def make_keywords(self) -> list[str]:
        """Return the base keywords plus pyrig-specific discovery keywords."""
        return [
            *super().make_keywords(),
            "project-setup",
            "scaffolding",
            "boilerplate",
            "project-template",
            "automation",
            "configuration",
            "developer-tools",
            "code-quality",
            "ci-cd",
            "devops",
        ]

    def make_classifiers(self) -> list[str]:
        """Return the base trove classifiers plus pyrig-specific classifiers."""
        return [
            *super().make_classifiers(),
            "Development Status :: 5 - Production/Stable",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "Topic :: Software Development :: Build Tools",
            "Topic :: Software Development :: Code Generators",
            "Topic :: Software Development :: Libraries :: Python Modules",
            "Topic :: Software Development :: Quality Assurance",
            "Topic :: Software Development :: Testing",
            "Topic :: System :: Software Distribution",
            "Topic :: System :: Installation/Setup",
        ]
make_classifiers()

Return the base trove classifiers plus pyrig-specific classifiers.

Source code in src/pyrig_overrides/rig/configs/pyproject.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def make_classifiers(self) -> list[str]:
    """Return the base trove classifiers plus pyrig-specific classifiers."""
    return [
        *super().make_classifiers(),
        "Development Status :: 5 - Production/Stable",
        "Environment :: Console",
        "Intended Audience :: Developers",
        "Topic :: Software Development :: Build Tools",
        "Topic :: Software Development :: Code Generators",
        "Topic :: Software Development :: Libraries :: Python Modules",
        "Topic :: Software Development :: Quality Assurance",
        "Topic :: Software Development :: Testing",
        "Topic :: System :: Software Distribution",
        "Topic :: System :: Installation/Setup",
    ]
make_keywords()

Return the base keywords plus pyrig-specific discovery keywords.

Source code in src/pyrig_overrides/rig/configs/pyproject.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
def make_keywords(self) -> list[str]:
    """Return the base keywords plus pyrig-specific discovery keywords."""
    return [
        *super().make_keywords(),
        "project-setup",
        "scaffolding",
        "boilerplate",
        "project-template",
        "automation",
        "configuration",
        "developer-tools",
        "code-quality",
        "ci-cd",
        "devops",
    ]

tools

Pyrig-specific overrides for external CLI tool wrappers.

Extends the tool definitions this package inherits from its dependencies with behavior and configuration specific to publishing pyrig itself.

dependencies

Pyrig-specific overrides for dependency tool wrappers.

auditor

Pyrig-specific dependency auditor override.

DependencyAuditor

Bases: DependencyAuditor

Extension point for applying pyrig-specific pip-audit customization.

Source code in src/pyrig_overrides/rig/tools/dependencies/auditor.py 
 9
10
11
12
13
14
class DependencyAuditor(BaseDependencyAuditor):
    """Extension point for applying pyrig-specific `pip-audit` customization."""

    def audit_args(self, *args: str) -> Args:
        """Overrides the base to adjust the arguments passed to `pip-audit`."""
        return super().audit_args(*args)
audit_args(*args)

Overrides the base to adjust the arguments passed to pip-audit.

Source code in src/pyrig_overrides/rig/tools/dependencies/auditor.py 
12
13
14
def audit_args(self, *args: str) -> Args:
    """Overrides the base to adjust the arguments passed to `pip-audit`."""
    return super().audit_args(*args)