API¶

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 tailored to pyrig's own project.

docs ¶

Pyrig-specific overrides for documentation configuration.

builder ¶

Pyrig-specific documentation configuration overrides.

DocsBuilderConfigFile ¶

Bases: DocsBuilderConfigFile

Pyrig-specific documentation configuration.

Disables mkdocstrings' default member filter, which hides single-underscore names. pyrig's core abstractions use single-underscore methods (e.g. ConfigFile._configs()) as the primary subclassing/override surface, so the API reference needs to document them.

_configs ¶

_configs() -> dict[str, Any]

Return the base structure with mkdocstrings' member filter disabled.

Returns:

Type	Description
`dict[str, Any]`	The configs structure with an empty mkdocstrings `filters` list.

Source code in src/pyrig_overrides/rig/configs/docs/builder.py

def _configs(self) -> dict[str, Any]:
    """Return the base structure with mkdocstrings' member filter disabled.

    Returns:
        The configs structure with an empty mkdocstrings `filters` list.
    """
    configs = super()._configs()
    options = configs["project"]["plugins"]["mkdocstrings"]["handlers"]["python"][
        "options"
    ]
    options["filters"] = []
    return configs

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 trove classifiers and keywords specific to pyrig on top of the base configuration.

classifiers_configs ¶

classifiers_configs() -> list[str]

Return the base trove classifiers plus pyrig-specific classifiers.

Source code in src/pyrig_overrides/rig/configs/pyproject.py

def classifiers_configs(self) -> list[str]:
    """Return the base trove classifiers plus pyrig-specific classifiers."""
    return [
        *super().classifiers_configs(),
        "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",
    ]

keywords_configs ¶

keywords_configs() -> list[str]

Return the base keywords plus pyrig-specific discovery keywords.

Source code in src/pyrig_overrides/rig/configs/pyproject.py

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

tools ¶

Pyrig-specific overrides for pyrig's own tool definitions.

pyrigger ¶

Pyrig-specific overrides for the pyrig CLI tool wrapper.

Pyrigger ¶

Bases: Pyrigger

Pyrig-specific pyrig CLI tool wrapper.

Excludes pyrig itself from the dev dependencies it declares, since pyrig is the tool managing this project rather than one of its dependencies.

dev_dependencies ¶

dev_dependencies() -> tuple[str, ...]

Return the base dev dependencies with pyrig's own package name removed.

Returns:

Type	Description
`tuple[str, ...]`	The base dev dependencies, excluding `self.name()`.

Source code in src/pyrig_overrides/rig/tools/pyrigger.py

def dev_dependencies(self) -> tuple[str, ...]:
    """Return the base dev dependencies with pyrig's own package name removed.

    Returns:
        The base dev dependencies, excluding `self.name()`.
    """
    dependencies = list(super().dev_dependencies())
    dependencies.remove(self.name())
    return tuple(dependencies)