Skip to content

API

Overrides for pyrig-runtime's own configuration and tooling.

rig

Mirrored overrides for pyrig-runtime's configuration and tool definitions.

configs

Overrides for pyrig-runtime's managed project configuration.

pyproject

PyPI metadata overrides for pyrig-runtime's generated project configuration.

PyprojectConfigFile

Bases: PyprojectConfigFile

Project metadata configuration customized for pyrig-runtime.

Adds pyrig-runtime-specific classifiers and PyPI search keywords to the shared metadata.

classifiers_configs 
classifiers_configs() -> list[str]

Return the base trove classifiers plus pyrig-runtime-specific classifiers.

Source code in src/pyrig_runtime_overrides/rig/configs/pyproject.py 
15
16
17
18
19
20
21
22
23
24
def classifiers_configs(self) -> list[str]:
    """Return the base trove classifiers plus pyrig-runtime-specific classifiers."""
    return [
        *super().classifiers_configs(),
        "Development Status :: 5 - Production/Stable",
        "Environment :: Console",
        "Intended Audience :: Developers",
        "Topic :: Software Development :: Libraries :: Application Frameworks",
        "Topic :: Software Development :: Libraries :: Python Modules",
    ]
keywords_configs 
keywords_configs() -> list[str]

Return the base keywords plus pyrig-runtime-specific PyPI search terms.

Source code in src/pyrig_runtime_overrides/rig/configs/pyproject.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
def keywords_configs(self) -> list[str]:
    """Return the base keywords plus pyrig-runtime-specific PyPI search terms."""
    return [
        *super().keywords_configs(),
        "automatic-plugin-discovery",
        "class-based-plugins",
        "cli",
        "cli-framework",
        "command-line-interface",
        "cross-package-plugins",
        "dependency-graph",
        "plugin-architecture",
        "plugin",
        "plugin-discovery",
        "plugin-framework",
        "plugin-system",
        "pyrig-runtime",
        "python-cli",
        "subclass-discovery",
    ]

tools

Mirrored overrides for pyrig-runtime's tool definitions.

pyrigger

Override the tool wrapper for the pyrig CLI itself.

Pyrigger

Bases: Pyrigger

Override for the pyrig CLI tool.

runtime_dependency 
runtime_dependency() -> str

Replace pyrig-runtime with typer as the runtime dependency.

pyrig-runtime cannot depend on itself, but its CLI is built with typer.

Returns:

Type Description
str

The typer distribution name.
Source code in src/pyrig_runtime_overrides/rig/tools/pyrigger.py 
11
12
13
14
15
16
17
18
19
def runtime_dependency(self) -> str:
    """Replace pyrig-runtime with typer as the runtime dependency.

    pyrig-runtime cannot depend on itself, but its CLI is built with typer.

    Returns:
        The `typer` distribution name.
    """
    return snake_to_kebab_case(typer.__name__)