typer-router

Overview

Build Typer CLI Apps with File System-Based Routing

Getting Started

Install typer-router:

pip install typer-router

A simple example:

import typer_router
from my_package import my_app

router = typer_router.Router.from_app_module(my_app)
app = router.to_typer(name="my_app_name")

See a more in-depth tutorial here.

Development Status

This project is currently in early-stage development. There may be breaking changes often. While the major version is 0, minor version upgrades will often have breaking changes.

Developing

First, you need a couple global dependencies installed, see their documentation for details:

• pipx
• direnv

Then clone the repo and run npm install and mvenv sync dev. Make your changes and then run just to run formatting, linting, and tests.

Develop documentation by running just docs to start up a dev server.

To run tests only, run just test. You can pass additional arguments to pytest, e.g. just test -k test_something.

Prior to committing, you can run just with no arguments to run all the checks.

Author

Created by Nick DeRobertis. MIT License.

Links

See the documentation here.