Skip to main content

A shell for typer apps with autocompletion and history

Project description

Typer Shell!

Beautiful command-line shell with Typer!

This is just an update to click-shell for typer.

I also added some features like:

  • better help by default
  • support for typer default functions (just name one of your commands 'default' and it will be triggered when nothing else is recognized)
  • easily drop into an ipython terminal with the local context loaded with 'shell'
  • each shell can have local parameters with helper functions for loading and saving them from files

See it in action!

And checkout the demp script:

#!/usr/bin/env python


from rich import print
from typer import Context

from typer_shell import make_typer_shell


class App:
    def __init__(self, name: str = "Bob"):
        self.name = name


app = make_typer_shell(prompt="🔥: ", obj=App(), params={"name": "Bob"}, params_path="params.yaml")
inner_app = make_typer_shell(prompt="🌲: ", params={"name": "Bob"}, params_path="innerparams.yaml")
app.add_typer(inner_app, name="inner")


@app.command()
@inner_app.command()
def foobar(name: str = "Bob"):
    "Foobar command"
    print("Hello", name)


@app.command()
def name(ctx: Context, name: str = "Bob"):
    "Name command"
    print("Hello", name)


# Set both the shell and the inner shell to have the same default
@app.command(hidden=True)
@inner_app.command(hidden=True)
def default(ctx: Context, line: str = "Bob"):
    "Name command wrapper for default"
    ctx.invoke(name, ctx=ctx, name=line)


if __name__ == "__main__":
    app()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

typer_shell-0.1.6.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

typer_shell-0.1.6-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file typer_shell-0.1.6.tar.gz.

File metadata

  • Download URL: typer_shell-0.1.6.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.6 Linux/5.19.0-41-generic

File hashes

Hashes for typer_shell-0.1.6.tar.gz
Algorithm Hash digest
SHA256 136f073f69af946e88b29f32d71e421d9f9a629263cd397b3155f6ce6f10606d
MD5 fc90697cf7194de6f763f4ba35b9bc79
BLAKE2b-256 dbaa844e29f504ddadd796d0359eb2bf388fa03463bdea4cbcdb3373908a6ae3

See more details on using hashes here.

File details

Details for the file typer_shell-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: typer_shell-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.6 Linux/5.19.0-41-generic

File hashes

Hashes for typer_shell-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 c6cdacfed3941105c4948e823c291460479c78e0cd88debb6647efb8d4e3969c
MD5 35cd18556d290ed42d0378b231965d12
BLAKE2b-256 7932c06f8462f88a0b69c7e508f9425596997a5dc90933e1cfec8f392c7d5968

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page