Skip to main content

An extension to typer that easily turns your typer app into a shell utility

Project description

typer-cmd

typer-cmd is an extension to typer that easily turns your typer app into a shell utility. It is built on top of the built in python cmd module, with modifications to make it work with typer.

Usage

pip install typer-cmd

Simply create a Typer instance and add it into the TyperCmd instance:

import typer
from typer_cmd.shell import TyperCmd


app = typer.Typer()

job_app = typer.Typer()
app.add_typer(job_app, name="job")


@app.command()
def hello(name: str):
    print("hello", name)


@job_app.command()
def run(name: str):
    print(f'run job {name}')


@job_app.command()
def list():
    print('list jobs')


if __name__ == "__main__":
    cmd = TyperCmd(typer=app)
    cmd.cmdloop()

or u can make a new subclass from TyperCmd and add your own necessary initializing code

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_cmd-0.0.2.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

typer_cmd-0.0.2-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file typer_cmd-0.0.2.tar.gz.

File metadata

  • Download URL: typer_cmd-0.0.2.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.9.3 CPython/3.11.5

File hashes

Hashes for typer_cmd-0.0.2.tar.gz
Algorithm Hash digest
SHA256 505e54e0d4a3366c56557f1e8ce9f26a14dffb599b93366fc742239180a1a5d6
MD5 4ac82e5a56c2bf3d8dbe15b4d4b53b9e
BLAKE2b-256 dc9dac21e50497f8abbc8fcec20cc312584d58582b8efa135c571da41c31874f

See more details on using hashes here.

File details

Details for the file typer_cmd-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: typer_cmd-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.9.3 CPython/3.11.5

File hashes

Hashes for typer_cmd-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9db7d62b3c9bad1bd13c4c3d0a36cc1301e2e1c163d0a3df9931db585f2736c8
MD5 828905d6136708b95b57012afd365777
BLAKE2b-256 10444e6976b9dc3e7b0ab8f3c1be095bffaa1ee40967415bc064eb008464911f

See more details on using hashes here.

Supported by

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