Skip to content

API Reference

Overrides for the project configuration pyrig generates by default.

rig

Project-specific overrides to pyrig's scaffolding and maintenance layer.

configs

Overrides for the configuration files pyrig manages for this project.

pyproject

Project-specific overrides for the generated pyproject.toml.

PyprojectConfigFile

Bases: PyprojectConfigFile

Overrides for the pyproject config.

Source code in src/pyrig_runtime_overrides/rig/configs/pyproject.py 
 9
10
11
12
13
14
15
16
17
18
19
20
class PyprojectConfigFile(BasePyprojectConfigFile):
    """Overrides for the pyproject config."""

    def additional_dependencies(self) -> list[str]:
        """Excludes the `pyrig-runtime` dependency from the additional dependencies.

        This prevents a circular dependency issue because pyrig-runtime cannot
        depend on itself.
        """
        deps = super().additional_dependencies()
        deps.remove(Pyrigger.I.runtime_dependency())
        return deps
additional_dependencies()

Excludes the pyrig-runtime dependency from the additional dependencies.

This prevents a circular dependency issue because pyrig-runtime cannot depend on itself.

Source code in src/pyrig_runtime_overrides/rig/configs/pyproject.py 
12
13
14
15
16
17
18
19
20
def additional_dependencies(self) -> list[str]:
    """Excludes the `pyrig-runtime` dependency from the additional dependencies.

    This prevents a circular dependency issue because pyrig-runtime cannot
    depend on itself.
    """
    deps = super().additional_dependencies()
    deps.remove(Pyrigger.I.runtime_dependency())
    return deps