Data

Tools

Indexes

Applications

Experiments

Open Source Science

typer

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

https://github.com/fastapi/typer

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.4%) to scientific vocabulary

Keywords

cli click python python3 shell terminal typehints typer

Keywords from Contributors

json-schema pydantic sqlalchemy uvicorn swagger-ui starlette redoc python-types openapi3 asyncio
Last synced: 4 months ago · JSON representation ·

Repository

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

Basic Info
Statistics
  • Stars: 17,789
  • Watchers: 79
  • Forks: 767
  • Open Issues: 172
  • Releases: 53
Topics
cli click python python3 shell terminal typehints typer
Created about 6 years ago · Last pushed 4 months ago
Metadata Files
Readme Contributing Funding License Citation Security

README.md

Typer

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

Test Publish Coverage Package version

Documentation: https://typer.tiangolo.com

Source Code: https://github.com/fastapi/typer

Typer is a library for building CLI applications that users will love using and developers will love creating. Based on Python type hints.

It's also a command line tool to run scripts, automatically converting them to CLI applications.

The key features are:

  • Intuitive to write: Great editor support. Completion everywhere. Less time debugging. Designed to be easy to use and learn. Less time reading docs.
  • Easy to use: It's easy to use for the final users. Automatic help, and automatic completion for all shells.
  • Short: Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs.
  • Start simple: The simplest example adds only 2 lines of code to your app: 1 import, 1 function call.
  • Grow large: Grow in complexity as much as you want, create arbitrarily complex trees of commands and groups of subcommands, with options and arguments.
  • 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.

FastAPI of CLIs

Typer is FastAPI's little sibling, it's the FastAPI of CLIs.

Installation

Create and activate a virtual environment and then install Typer:

```console $ pip install typer ---> 100% Successfully installed typer rich shellingham ```

Example

The absolute minimum

  • Create a file main.py with:

Python def main(name: str): print(f"Hello {name}")

This script doesn't even use Typer internally. But you can use the typer command to run it as a CLI application.

Run it

Run your application with the typer command:

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

This is the simplest use case, not even using Typer internally, but it can already be quite useful for simple scripts.

Note: auto-completion works when you create a Python package and run it with --install-completion or when you use the typer command.

Use Typer in your code

Now let's start using Typer in your own code, update main.py with:

```Python import typer

def main(name: str): print(f"Hello {name}")

if name == "main": typer.run(main) ```

Now you could run it with Python directly:

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

Note: you can also call this same script with the typer command, but you don't need to.

Example upgrade

This was the simplest example possible.

Now let's see one a bit more complex.

An example with two subcommands

Modify the file main.py.

Create a typer.Typer() app, and create two subcommands with their parameters.

```Python hl_lines="3 6 11 20" import typer

app = typer.Typer()

@app.command() def hello(name: str): print(f"Hello {name}")

@app.command() def goodbye(name: str, formal: bool = False): if formal: print(f"Goodbye Ms. {name}. Have a good day.") else: print(f"Bye {name}!")

if name == "main": app() ```

And that will:

  • Explicitly create a typer.Typer app.
    • The previous typer.run actually creates one implicitly for you.
  • Add two subcommands with @app.command().
  • Execute the app() itself, as if it was a function (instead of typer.run).

Run the upgraded example

Check the new help:

```console $ python main.py --help Usage: main.py [OPTIONS] COMMAND [ARGS]... ╭─ Options ─────────────────────────────────────────╮ │ --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 ────────────────────────────────────────╮ │ goodbye │ │ hello │ ╰───────────────────────────────────────────────────╯ // When you create a package you get ✨ auto-completion ✨ for free, installed with --install-completion // You have 2 subcommands (the 2 functions): goodbye and hello ```

Now check the help for the hello command:

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

And now check the help for the goodbye command:

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

Now you can try out the new command line application:

```console // Use it with the hello command $ python main.py hello Camila Hello Camila // And with the goodbye command $ python main.py goodbye Camila Bye Camila! // And with --formal $ python main.py goodbye --formal Camila Goodbye Ms. Camila. Have a good day. ```

Recap

In summary, you declare once the types of parameters (CLI arguments and CLI options) as function parameters.

You do that with standard modern Python types.

You don't have to learn a new syntax, the methods or classes of a specific library, etc.

Just standard Python.

For example, for an int:

Python total: int

or for a bool flag:

Python force: bool

And similarly for files, paths, enums (choices), etc. And there are tools to create groups of subcommands, add metadata, extra validation, etc.

You get: great editor support, including completion and type checks everywhere.

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.

For a more complete example including more features, see the Tutorial - User Guide.

Dependencies

Typer stands on the shoulders of a giant. Its only internal required dependency is Click.

By default it also comes with extra standard dependencies:

  • rich: to show nicely formatted errors automatically.
  • shellingham: to automatically detect the current shell when installing completion.
    • With shellingham you can just use --install-completion.
    • Without shellingham, you have to pass the name of the shell to install completion for, e.g. --install-completion bash.

typer-slim

If you don't want the extra standard optional dependencies, install typer-slim instead.

When you install with:

bash pip install typer

...it includes the same code and dependencies as:

bash pip install "typer-slim[standard]"

The standard extra dependencies are rich and shellingham.

Note: The typer command is only included in the typer package.

License

This project is licensed under the terms of the MIT license.

Owner

  • Name: FastAPI
  • Login: fastapi
  • Kind: organization

FastAPI and friends open source projects. Created and managed by @tiangolo.

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Typer
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Sebastián
    family-names: Ramírez
    email: tiangolo@gmail.com
identifiers:
repository-code: 'https://github.com/fastapi/typer'
url: 'https://typer.tiangolo.com'
abstract: >-
  Typer, build great CLIs. Easy to code. Based on Python type hints.
keywords:
  - typer
  - click
license: MIT

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 970
  • Total Committers: 78
  • Avg Commits per committer: 12.436
  • Development Distribution Score (DDS): 0.59
Past Year
  • Commits: 402
  • Committers: 28
  • Avg Commits per committer: 14.357
  • Development Distribution Score (DDS): 0.517
Top Committers
Name Email Commits
Sebastián Ramírez t****o@g****m 398
github-actions g****s@g****m 346
dependabot[bot] 4****] 77
Sofie Van Landeghem s****g 33
pre-commit-ci[bot] 6****] 32
Patrick Arminio p****o@g****m 4
Maria Camila Gutierrez m****0@g****m 3
Iván Todorovich i****h@g****m 3
Evan E. Baird m****r@g****m 3
JAYATI SHRIVASTAVA g****e@g****m 2
Matthias Bach m****x@m****g 2
Jonas M. Miguel 4****l 1
Jonas L. B. d****b@g****m 1
John Purviance j****e@g****m 1
Javier Alvarez Jiménez 4****8 1
Jakub Jakubec t****u@g****m 1
Irvin Ho 8****r 1
Fernando Pérez-García f****r@g****m 1
Fabio Ramalho 6****o 1
Esteban Maya e****9@g****m 1
Edgar Ramírez Mondragón e****8@g****m 1
Diego Piloni d****i@g****m 1
David Montague 3****u 1
David Larlet 3****k 1
Danilo Horta d****a@p****e 1
Ryan Miller Galamb 1****b 1
Alexandre Sieira a****a@g****m 1
Alvaro Valdebenito a****e@g****m 1
Aryaz Eghbali 6****E 1
Asthestarsfalll 7****l 1
and 48 more...
Committer Domains (Top 20 + Academic)
uottawa.ca: 1 paulo.costa.nom.br: 1 nickdmartin.com: 1 ymail.com: 1 antmicro.com: 1 seznam.cz: 1 snapbug.geek.nz: 1 jurkiewi.cz: 1 huxuan.org: 1 valentincalomme.com: 1 yandex.ru: 1 productscience.net: 1 xmlizer.net: 1 musicinmybrain.net: 1 pm.me: 1 marix.org: 1 github.com: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 90
  • Total pull requests: 503
  • Average time to close issues: about 1 year
  • Average time to close pull requests: about 2 months
  • Total issue authors: 78
  • Total pull request authors: 82
  • Average comments per issue: 6.47
  • Average comments per pull request: 1.88
  • Merged pull requests: 283
  • Bot issues: 1
  • Bot pull requests: 236
Past Year
  • Issues: 8
  • Pull requests: 333
  • Average time to close issues: 4 days
  • Average time to close pull requests: 13 days
  • Issue authors: 8
  • Pull request authors: 42
  • Average comments per issue: 0.38
  • Average comments per pull request: 1.34
  • Merged pull requests: 167
  • Bot issues: 1
  • Bot pull requests: 209
View more stats
Top Authors
Issue Authors
  • tiangolo (5)
  • dbanty (3)
  • Leletir (2)
  • NixBiks (2)
  • taranlu-houzz (2)
  • dependabot[bot] (2)
  • tmbdev (2)
  • lorddaedra (2)
  • euri10 (2)
  • fschlz (2)
  • rgreinho (1)
  • RobW3LGA (1)
  • mdantonio (1)
  • enbermudas (1)
  • rmorshea (1)
Pull Request Authors
  • dependabot[bot] (228)
  • tiangolo (112)
  • pre-commit-ci[bot] (48)
  • svlandeg (46)
  • rickwporter (8)
  • patrick91 (7)
  • gkeuccsr (4)
  • bckohan (4)
  • ivantodorovich (3)
  • mhkarimi1383 (3)
  • zarch (3)
  • rokbot (3)
  • Fabian665 (3)
  • gbdlin (2)
  • snapbug (2)
Top Labels
Issue Labels
feature (35) question (28) bug (20) investigate (11) answered (8) shell / zsh (5) internal (3) dependencies (2) confirmed (1) good first issue (1) p2 (1) docs (1) github_actions (1) python (1)
Pull Request Labels
internal (308) dependencies (233) python (198) feature (54) p3 (41) docs (35) github_actions (29) bug (27) p2 (16) refactor (14) repo / tests (8) types (6) os / windows (5) shell / zsh (4) upgrade (4) breaking (3) shell / bash (2) shell / powershell (2) waiting (2) click (2) shell / fish (1)

Packages

  • Total packages: 11
  • Total downloads:
    • pypi 83,454,836 last-month
  • Total docker downloads: 2,120,272,393
  • Total dependent packages: 2,425
    (may contain duplicates)
  • Total dependent repositories: 9,951
    (may contain duplicates)
  • Total versions: 142
  • Total maintainers: 3
pypi.org: typer

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

  • Versions: 58
  • Dependent Packages: 2,391
  • Dependent Repositories: 9,797
  • Downloads: 82,895,673 Last month
  • Docker Downloads: 2,120,272,091
Rankings
Dependent packages count: 0.0%
Downloads: 0.1%
Docker downloads count: 0.1%
Dependent repos count: 0.1%
Stargazers count: 0.4%
Average: 0.6%
Forks count: 3.0%
Maintainers (1)
tiangolo
Last synced: 4 months ago
pypi.org: typer-cli

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

  • Versions: 37
  • Dependent Packages: 29
  • Dependent Repositories: 154
  • Downloads: 70,014 Last month
  • Docker Downloads: 302
Rankings
Dependent packages count: 0.5%
Dependent repos count: 1.2%
Downloads: 1.6%
Docker downloads count: 2.3%
Average: 2.7%
Stargazers count: 3.5%
Forks count: 7.1%
Maintainers (1)
tiangolo
Last synced: 4 months ago
alpine-edge: py3-typer-doc

Building CLI applications (documentation)

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Average: 7.0%
Dependent packages count: 14.0%
Maintainers (1)
iztok@iztok.dev
Last synced: 4 months ago
alpine-edge: py3-typer

Building CLI applications

  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Average: 7.4%
Dependent packages count: 14.9%
Maintainers (1)
iztok@iztok.dev
Last synced: 4 months ago
alpine-edge: py3-typer-pyc

Precompiled Python bytecode for py3-typer

  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Average: 7.4%
Dependent packages count: 14.9%
Maintainers (1)
iztok@iztok.dev
Last synced: 4 months ago
pypi.org: typer-slim

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

  • Versions: 25
  • Dependent Packages: 5
  • Dependent Repositories: 0
  • Downloads: 489,149 Last month
Rankings
Stargazers count: 0.2%
Forks count: 2.3%
Dependent packages count: 10.1%
Average: 19.9%
Dependent repos count: 67.1%
Maintainers (1)
tiangolo
Last synced: 4 months ago
alpine-v3.22: py3-typer-pyc

Precompiled Python bytecode for py3-typer

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Maintainers (1)
iztok@iztok.dev
Last synced: 4 months ago
alpine-v3.22: py3-typer

Building CLI applications

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Maintainers (1)
iztok@iztok.dev
Last synced: 4 months ago
alpine-v3.21: py3-typer

Building CLI applications

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Maintainers (1)
iztok@iztok-jr-fister.eu
Last synced: 4 months ago
alpine-v3.22: py3-typer-doc

Building CLI applications (documentation)

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Maintainers (1)
iztok@iztok.dev
Last synced: 4 months ago
alpine-v3.21: py3-typer-pyc

Precompiled Python bytecode for py3-typer

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Maintainers (1)
iztok@iztok-jr-fister.eu
Last synced: 4 months ago