Skip to content

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 
19
20
21
22
23
24
25
26
27
28
29
30
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 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def keywords_configs(self) -> list[str]:
    """Return the base keywords plus pyrig-specific discovery keywords."""
    return [
        *super().keywords_configs(),
        "automation",
        "boilerplate",
        "ci-cd",
        "code-generation",
        "code-quality",
        "configuration",
        "convention-over-configuration",
        "developer-tools",
        "devops",
        "github-actions",
        "infrastructure-as-code",
        "project-generator",
        "project-maintenance",
        "project-scaffolding",
        "project-setup",
        "python-project",
        "test-generation",
        "test-scaffolding",
    ]