Skip to content

API

The top-level package for the project.

rig

Package initialization.

cli

Package initialization.

commands

Package initialization.

check

Check command module.

check_order
check_order() -> None

Check the order.

Source code in src/pyorder/rig/cli/commands/check.py
def check_order() -> None:
    """Check the order."""

subcommands

Project-specific CLI commands.

Functions defined directly in this module are registered as top-level CLI commands. Module-level typer.Typer instances are registered as command groups, with each group's name derived from the kebab-case form of the variable name.

check
check() -> None

This is a cli subcommand.

Source code in src/pyorder/rig/cli/subcommands.py
def check() -> None:
    """This is a cli subcommand."""
    from pyorder.rig.cli.commands.check import check_order  # noqa: PLC0415

    check_order()