Skip to content

Home

CI CD ProjectTester

ByteOrderMarkerFormatter CaseConflictChecker DependencyChecker EndOfFileFormatter EndOfLineFormatter JSONFormatter JSONLinter LargeFileChecker MarkdownLinter MergeConflictChecker ModuleTestNamingChecker PythonLinter SecretsChecker SecurityChecker ShellFormatter ShellLinter SpellChecker TOMLLinter TrailingWhitespaceFormatter TypeChecker YAMLLinter

PackageManager Pyrigger RemoteVersionController VersionControlHookManager VersionController

DocsBuilder PackageIndex ProgrammingLanguage License

A pyrig plugin that adds resources support.

Overview

Drop-in pyrig plugin that gives your project a conventional home for static resource files:

  • Adds a rig/resources/ package to the target project, created and kept in place by pyrig sync.

No configuration required — installing the package as a development dependency is the whole setup. Then regenerate your pyrig configs as usual and the plugin's config file is picked up automatically.

Installation

uv add pyrig-resources --dev
uv run pyrig sync

After running pyrig sync, the package lives at src/<your_project>/rig/resources/, ready for your static files.

How it works

The plugin subclasses one pyrig base class:

  • CopyInitDocstringConfigFile (as ResourcesInitConfigFile) to declare the rig/resources/ package. pyrig's cross-package subclass discovery finds this config during sync, resolves the source module's dotted name into your project's package tree, and writes the generated __init__.py — seeding it with the docstring of the plugin's own resources package.

API Reference

For class- and method-level details, see the API Reference, generated automatically from the source.