API¶

A pyrig plugin that scaffolds a static-resources package into a project.

Once installed as a dependency, pyrig sync creates a rig/resources/ package in the target project, giving it a conventional home for static resource files bundled with the project.

rig ¶

Integration namespace exposing this plugin's contributions to pyrig.

Mirrors pyrig's own rig layout, the shared convention this plugin's contributions must follow to be usable by pyrig's tooling.

configs ¶

This plugin's config-file contributions to pyrig.

pyrig discovers these during pyrig sync and generates or updates the corresponding files in projects that install the plugin.

resources_init ¶

Configuration for generating the target project's rig/resources/__init__.py.

ResourcesInitConfigFile ¶

Bases: CopyInitDocstringConfigFile

Config file for the target project's rig/resources/__init__.py.

copy_module ¶

copy_module() -> ModuleType

Return this plugin's resources package.

Source code in src/pyrig_resources/rig/configs/resources_init.py

def copy_module(self) -> ModuleType:
    """Return this plugin's `resources` package."""
    return resources

resources ¶

Static resource files bundled with the project.