Skip to content

📦 jeeves package instead of jeeves.py file

Instead of Jeeves.py file, a Python package named jeeves can also be used.

  • That helps to structure code better if you have multiple commands,
  • You no longer need to make sub-commands hidden.
jeeves/__init__.py
from jeeves.lint import lint
from jeeves.test import test
jeeves/test.py
import typer

test = typer.Typer()


@test.command()
def unit():
    """Run unit tests."""


@test.command()
def integration():
    """Run integration tests."""
jeeves/lint.py
import typer

lint = typer.Typer(no_args_is_help=True)


@lint.command()
def mypy():
    """Run mypy."""


@lint.command()
def flake8():
    """Run flake8."""
    print(flake8.__doc__)

Top level documentation

↦ j
 Usage: j [OPTIONS] COMMAND [ARGS]...                                           

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --log-level                 [debug|info|error]  Logging level.               │
│                                                 [default: LogLevel.ERROR]    │
│ --install-completion                            Install completion for the   │
│                                                 current shell.               │
│ --show-completion                               Show completion for the      │
│                                                 current shell, to copy it or │
│                                                 customize the installation.  │
│ --help                                          Show this message and exit.  │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ lint                                                                         │
│ test                                                                         │
╰──────────────────────────────────────────────────────────────────────────────╯

Command documentation

↦ j lint
 Usage: j lint [OPTIONS] COMMAND [ARGS]...                                      

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                  │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ flake8                       Run flake8.                                     │
│ mypy                         Run mypy.                                       │
╰──────────────────────────────────────────────────────────────────────────────╯

Sub command documentation

↦ j lint flake8 --help
 Usage: j lint flake8 [OPTIONS]                                                 

 Run flake8.                                                                    

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                  │
╰──────────────────────────────────────────────────────────────────────────────╯

…and execution

↦ j lint flake8
Run flake8.