Skip to content

Home

CI CD ProjectTester

ByteOrderMarkerFormatter CICDLinter CICDSecurityChecker 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 for pyrig plugins.

Overview

Drop-in pyrig plugin for projects that are themselves pyrig plugins. Pyrig discovers plugin implementations in installed packages that declare pyrig as a dependency. This plugin ensures the plugin project has that required runtime dependency, while this plugin itself is installed as a development dependency.

Installation

uv add pyrig-plugin --dev
uv run pyrig sync

How it works

The plugin subclasses pyrig's Pyrigger and sets pyrig as the project's runtime dependency. When pyrig sync is invoked, the project's pyproject.toml declares pyrig instead of pyrig-runtime. Since pyrig itself depends on pyrig-runtime, plugin projects only need to declare pyrig.

It also adds pyrig as an ignore entry to the deptry tool entry in the pyproject.toml. This also happens automatically when pyrig sync is run. This is needed so deptry does not mistakenly report pyrig as an unused dependency.

API Reference

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