Skip to content

pyrig-runtime Documentation

CI CD

CoverageTester ProjectTester

DependencyAuditor DependencyChecker MarkdownLinter PythonLinter SecurityChecker SpellChecker TypeChecker VersionControlHookManager

PackageManager Pyrigger RemoteVersionController VersionController

DocsBuilder PackageIndex ProgrammingLanguage License

Runtime dependency and library for projects built with pyrig.

Overview

pyrig-runtime is the runtime layer that projects built with pyrig depend on. It bundles the capabilities those projects rely on while they run.

It is a standalone library — its only dependency is Typer, and nothing here requires pyrig itself to be installed. pyrig is the build- and development-time toolkit; pyrig-runtime is the piece that ships with the projects pyrig creates.

Installation

In most cases you do not install it directly as pyrig adds it to a project's dependencies for you when you initialize a project with it. But if you for example want to use the plugin discovery for your own interests you can add it like any other python package:

uv add pyrig-runtime
# or
pip install pyrig-runtime

Features

pyrig-runtime provides two main capabilities. Each has its own page with more detail:

  • Plugin discovery — define a base class and its subclasses are discovered automatically across every installed package that depends on it, with no registration step..
  • Automatic CLI — every project gets a working command-line interface.

API reference

Every public module, class, and function is documented from its source in the API reference.