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.2.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

typer_shell-0.1.2-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: typer_shell-0.1.2.tar.gz
  • Upload date:
  • Size: 3.7 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.2.tar.gz
Algorithm Hash digest
SHA256 0eabca3811fe5b1451121a4ac410e84049275f9df2ba776b5edd5e572206c637
MD5 6b380f2c3c098a16e0e5bfd56c152826
BLAKE2b-256 e6dbf8492fc6bc22cebf52e959c81b3729e8d3a26ed47bd632c337924a952eac

See more details on using hashes here.

File details

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

File metadata

  • Download URL: typer_shell-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 4.2 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9251149e6919f45d1c594463e1e9077aadb75b72392b78398f497bf2954aa052
MD5 f4668da1a1f0780e03f9de52fe93ff05
BLAKE2b-256 4e477c9aef90661c45fd4f215cc0cf5c725550eac5de1e2a0c078ce848096aef

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