{"author":null,"author_email":"=?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= ","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Intended Audience :: Developers","Intended Audience :: Information Technology","Intended Audience :: System Administrators","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Software Development","Topic :: Software Development :: Libraries","Topic :: Software Development :: Libraries :: Application Frameworks","Topic :: Software Development :: Libraries :: Python Modules","Typing :: Typed"],"description":"

\n $\"Typer\"$ \n\n

\n Typer, build great CLIs. Easy to code. Based on Python type hints.\n

\n\n $\"Test\"$ \n\n\n $\"Publish\"$ \n\n\n $\"Coverage\"$ \n \n $\"Package$ \n\n

\n\n---\n\n**Documentation**: https://typer.tiangolo.com\n\n**Source Code**: https://github.com/fastapi/typer\n\n---\n\nTyper is a library for building CLI applications that users will **love using** and developers will **love creating**. Based on Python type hints.\n\nIt's also a command line tool to run scripts, automatically converting them to CLI applications.\n\nThe key features are:\n\n* **Intuitive to write**: Great editor support. Completion everywhere. Less time debugging. Designed to be easy to use and learn. Less time reading docs.\n* **Easy to use**: It's easy to use for the final users. Automatic help, and automatic completion for all shells.\n* **Short**: Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs.\n* **Start simple**: The simplest example adds only 2 lines of code to your app: **1 import, 1 function call**.\n* **Grow large**: Grow in complexity as much as you want, create arbitrarily complex trees of commands and groups of subcommands, with options and arguments.\n* **Run scripts**: Typer includes a `typer` command/program that you can use to run scripts, automatically converting them to CLIs, even if they don't use Typer internally.\n\n## FastAPI of CLIs\n\n**Typer** is FastAPI's little sibling, it's the FastAPI of CLIs.\n\n## Installation\n\nCreate and activate a virtual environment and then install **Typer**:\n\n

\n\n```console\n$ pip install typer\n---> 100%\nSuccessfully installed typer rich shellingham\n```\n\n

\n\n## Example\n\n### The absolute minimum\n\n* Create a file `main.py` with:\n\n```Python\ndef main(name: str):\n print(f\"Hello {name}\")\n```\n\nThis script doesn't even use Typer internally. But you can use the `typer` command to run it as a CLI application.\n\n### Run it\n\nRun your application with the `typer` command:\n\n

\n\n```console\n// Run your application\n$ typer main.py run\n\n// You get a nice error, you are missing NAME\nUsage: typer [PATH_OR_MODULE] run [OPTIONS] NAME\nTry 'typer [PATH_OR_MODULE] run --help' for help.\n╭─ Error ───────────────────────────────────────────╮\n│ Missing argument 'NAME'. │\n╰───────────────────────────────────────────────────╯\n\n\n// You get a --help for free\n$ typer main.py run --help\n\nUsage: typer [PATH_OR_MODULE] run [OPTIONS] NAME\n\nRun the provided Typer app.\n\n╭─ Arguments ───────────────────────────────────────╮\n│ * name TEXT [default: None] [required] |\n╰───────────────────────────────────────────────────╯\n╭─ Options ─────────────────────────────────────────╮\n│ --help Show this message and exit. │\n╰───────────────────────────────────────────────────╯\n\n// Now pass the NAME argument\n$ typer main.py run Camila\n\nHello Camila\n\n// It works! 🎉\n```\n\n

\n\nThis is the simplest use case, not even using Typer internally, but it can already be quite useful for simple scripts.\n\n**Note**: auto-completion works when you create a Python package and run it with `--install-completion` or when you use the `typer` command.\n\n## Use Typer in your code\n\nNow let's start using Typer in your own code, update `main.py` with:\n\n```Python\nimport typer\n\n\ndef main(name: str):\n print(f\"Hello {name}\")\n\n\nif __name__ == \"__main__\":\n typer.run(main)\n```\n\nNow you could run it with Python directly:\n\n

\n\n```console\n// Run your application\n$ python main.py\n\n// You get a nice error, you are missing NAME\nUsage: main.py [OPTIONS] NAME\nTry 'main.py --help' for help.\n╭─ Error ───────────────────────────────────────────╮\n│ Missing argument 'NAME'. │\n╰───────────────────────────────────────────────────╯\n\n\n// You get a --help for free\n$ python main.py --help\n\nUsage: main.py [OPTIONS] NAME\n\n╭─ Arguments ───────────────────────────────────────╮\n│ * name TEXT [default: None] [required] |\n╰───────────────────────────────────────────────────╯\n╭─ Options ─────────────────────────────────────────╮\n│ --help Show this message and exit. │\n╰───────────────────────────────────────────────────╯\n\n// Now pass the NAME argument\n$ python main.py Camila\n\nHello Camila\n\n// It works! 🎉\n```\n\n

\n\n**Note**: you can also call this same script with the `typer` command, but you don't need to.\n\n## Example upgrade\n\nThis was the simplest example possible.\n\nNow let's see one a bit more complex.\n\n### An example with two subcommands\n\nModify the file `main.py`.\n\nCreate a `typer.Typer()` app, and create two subcommands with their parameters.\n\n```Python hl_lines=\"3 6 11 20\"\nimport typer\n\napp = typer.Typer()\n\n\n@app.command()\ndef hello(name: str):\n print(f\"Hello {name}\")\n\n\n@app.command()\ndef goodbye(name: str, formal: bool = False):\n if formal:\n print(f\"Goodbye Ms. {name}. Have a good day.\")\n else:\n print(f\"Bye {name}!\")\n\n\nif __name__ == \"__main__\":\n app()\n```\n\nAnd that will:\n\n* Explicitly create a `typer.Typer` app.\n * The previous `typer.run` actually creates one implicitly for you.\n* Add two subcommands with `@app.command()`.\n* Execute the `app()` itself, as if it was a function (instead of `typer.run`).\n\n### Run the upgraded example\n\nCheck the new help:\n\n

\n\n```console\n$ python main.py --help\n\n Usage: main.py [OPTIONS] COMMAND [ARGS]...\n\n╭─ Options ─────────────────────────────────────────╮\n│ --install-completion Install completion │\n│ for the current │\n│ shell. │\n│ --show-completion Show completion for │\n│ the current shell, │\n│ to copy it or │\n│ customize the │\n│ installation. │\n│ --help Show this message │\n│ and exit. │\n╰───────────────────────────────────────────────────╯\n╭─ Commands ────────────────────────────────────────╮\n│ goodbye │\n│ hello │\n╰───────────────────────────────────────────────────╯\n\n// When you create a package you get ✨ auto-completion ✨ for free, installed with --install-completion\n\n// You have 2 subcommands (the 2 functions): goodbye and hello\n```\n\n

\n\nNow check the help for the `hello` command:\n\n

\n\n```console\n$ python main.py hello --help\n\n Usage: main.py hello [OPTIONS] NAME\n\n╭─ Arguments ───────────────────────────────────────╮\n│ * name TEXT [default: None] [required] │\n╰───────────────────────────────────────────────────╯\n╭─ Options ─────────────────────────────────────────╮\n│ --help Show this message and exit. │\n╰───────────────────────────────────────────────────╯\n```\n\n

\n\nAnd now check the help for the `goodbye` command:\n\n

\n\n```console\n$ python main.py goodbye --help\n\n Usage: main.py goodbye [OPTIONS] NAME\n\n╭─ Arguments ───────────────────────────────────────╮\n│ * name TEXT [default: None] [required] │\n╰───────────────────────────────────────────────────╯\n╭─ Options ─────────────────────────────────────────╮\n│ --formal --no-formal [default: no-formal] │\n│ --help Show this message │\n│ and exit. │\n╰───────────────────────────────────────────────────╯\n\n// Automatic --formal and --no-formal for the bool option 🎉\n```\n\n

\n\nNow you can try out the new command line application:\n\n

\n\n```console\n// Use it with the hello command\n\n$ python main.py hello Camila\n\nHello Camila\n\n// And with the goodbye command\n\n$ python main.py goodbye Camila\n\nBye Camila!\n\n// And with --formal\n\n$ python main.py goodbye --formal Camila\n\nGoodbye Ms. Camila. Have a good day.\n```\n\n

\n\n### Recap\n\nIn summary, you declare **once** the types of parameters (*CLI arguments* and *CLI options*) as function parameters.\n\nYou do that with standard modern Python types.\n\nYou don't have to learn a new syntax, the methods or classes of a specific library, etc.\n\nJust standard **Python**.\n\nFor example, for an `int`:\n\n```Python\ntotal: int\n```\n\nor for a `bool` flag:\n\n```Python\nforce: bool\n```\n\nAnd similarly for **files**, **paths**, **enums** (choices), etc. And there are tools to create **groups of subcommands**, add metadata, extra **validation**, etc.\n\n**You get**: great editor support, including **completion** and **type checks** everywhere.\n\n**Your users get**: automatic **`--help`**, **auto-completion** in their terminal (Bash, Zsh, Fish, PowerShell) when they install your package or when using the `typer` command.\n\nFor a more complete example including more features, see the Tutorial - User Guide.\n\n## Dependencies\n\n**Typer** stands on the shoulders of a giant. Its only internal required dependency is Click.\n\nBy default it also comes with extra standard dependencies:\n\n* rich: to show nicely formatted errors automatically.\n* shellingham: to automatically detect the current shell when installing completion.\n * With `shellingham` you can just use `--install-completion`.\n * Without `shellingham`, you have to pass the name of the shell to install completion for, e.g. `--install-completion bash`.\n\n### `typer-slim`\n\nIf you don't want the extra standard optional dependencies, install `typer-slim` instead.\n\nWhen you install with:\n\n```bash\npip install typer\n```\n\n...it includes the same code and dependencies as:\n\n```bash\npip install \"typer-slim[standard]\"\n```\n\nThe `standard` extra dependencies are `rich` and `shellingham`.\n\n**Note**: The `typer` command is only included in the `typer` package.\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":null,"license":null,"license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"typer","package_url":"https://pypi.org/project/typer/","platform":null,"project_url":"https://pypi.org/project/typer/","project_urls":{"Changelog":"https://typer.tiangolo.com/release-notes/","Documentation":"https://typer.tiangolo.com","Homepage":"https://github.com/fastapi/typer","Issues":"https://github.com/fastapi/typer/issues","Repository":"https://github.com/fastapi/typer"},"provides_extra":null,"release_url":"https://pypi.org/project/typer/0.15.4/","requires_dist":["click<8.2,>=8.0.0","typing-extensions>=3.7.4.3","shellingham>=1.3.0","rich>=10.11.0"],"requires_python":">=3.7","summary":"Typer, build great CLIs. Easy to code. Based on Python type hints.","version":"0.15.4","yanked":false,"yanked_reason":null}

Dependencies of typer (4).
Dependency	Optional
click	false
rich	false
shellingham	false
typing-extensions	false

Package search

typer

project_urls

Dependencies

All package metadata

Releases