0.9.1

Fixes

• 🐛 Add missing default_factory in Argument overloads. PR #750 by @m9810223.
• 🐛 Fix preserving case in enum values. PR #571 by @avaldebe.

Docs

• 📝 Remove obsolete references to --install-completion for typer.run() scripts. PR #595 by @tiangolo.

• 📝 Update docs example for a Typer/Click group to make new subcommands explicit. PR #755 by @svlandeg.

• 📝 Update docs for building a package, file structure example. PR #683 by @davidbgk.

• 📝 Update link in docs to the newest stable version of click. PR #675 by @javier171188.

• 🔧 Add CITATION.cff file for academic citations. PR #681 by @tiangolo.

• ✏ Fix typo in docs/tutorial/exceptions.md. PR #702 by @menzenski.

• ✏ Fix typo in docs/tutorial/options/name.md. PR #725 by @bwagner.

• ✏ Fix typo in docs/tutorial/arguments/optional.md. PR #602 by @tadasgedgaudas.

Internal

• ⬆ [pre-commit.ci] pre-commit autoupdate. PR #606 by @pre-commit-ci[bot].
• 👷 Install MkDocs Material Insiders only when secrets are available, for Dependabot. PR #685 by @tiangolo.
• ⚒️ Update build-docs.yml, do not zip docs. PR #645 by @tiangolo.
• 👷 Deploy docs to Cloudflare. PR #644 by @tiangolo.
• 👷 Upgrade CI for docs. PR #642 by @tiangolo.
• 👷 Update token for latest changes. PR #635 by @tiangolo.
• 👷 Update CI workflow dispatch for latest changes. PR #643 by @tiangolo.
• 👷 Update token for Material for MkDocs Insiders. PR #636 by @tiangolo.
• 🐛 Fix internal type annotations and bump mypy version. PR #638 by @paulo-raca.
• 💡 Add comments to document overload definitions in code. PR #752 by @svlandeg.
• 🔥 Remove Jina QA Bot as it has been discontinued. PR #749 by @tiangolo.
• 👷 Update build docs CI cache paths. PR #707 by @tiangolo.
• 👷 Upgrade latest-changes GitHub Action. PR #691 by @tiangolo.

0.9.0

Features

• ✨ Add support for PEP-593 Annotated for specifying options and arguments. Initial PR #584 by @ryangalamb.
  • New docs: Optional CLI arguments.
  • It is no longer required to pass a default value of ... to mark a CLI Argument or CLI Option as required.
  • It is now recommended to use Annotated for typer.Option() and typer.Argument().
  • All the docs have been updated to recommend Annotated.

Docs

• 📝 Update docs examples for custom param types using Annotated, fix overloads for typer.Argument. PR #594 by @tiangolo.

Internal

• ⬆ [pre-commit.ci] pre-commit autoupdate. PR #592 by @pre-commit-ci[bot].

0.8.0

Features

• ✨ Add support for custom types and parsers. Initial PR #583 by @jpurviance. Based on original PR #443 by @paulo-raca.
  • New docs: CLI Parameter Types: Custom Types.

Upgrades

• ⬆ Upgrade Rich, support 13.x. PR #524 by @musicinmybrain.

Docs

• 📝 Tweak docs, Custom Types path, main page and READAME colors, broken links. PR #588 by @tiangolo.
• ✏ Fix spelling (shinny -> shiny). PR #586 by @runofthemill.
• 📝 Update docs about helping Typer. PR #547 by @tiangolo.
• ✏️ Fix typo in datetime docs. PR #495 by @huxuan.
• ✏️ Add quotes to package name that includes brackets in docs. PR #475 by @gjolga.

Internal

• ⬆ Bump dawidd6/action-download-artifact from 2.24.2 to 2.26.0. PR #558 by @dependabot[bot].
• ⬆ [pre-commit.ci] pre-commit autoupdate. PR #549 by @pre-commit-ci[bot].
• 🔧 Add exclude_lines to coverage configuration. PR #585 by @dmontagu.
• ⬆️ Upgrade analytics. PR #557 by @tiangolo.
• 🔧 Update new issue chooser to suggest GitHub Discussions. PR #544 by @tiangolo.
• 🔧 Add GitHub Discussion templates for questions. PR #541 by @tiangolo.
• 🔧 Update pre-commit, Python version, isort version. PR #542 by @tiangolo.
• ⬆ [pre-commit.ci] pre-commit autoupdate. PR #512 by @pre-commit-ci[bot].
• ⬆ Bump nwtgck/actions-netlify from 1.2.4 to 2.0.0. PR #513 by @dependabot[bot].
• 👷 Refactor CI artifact upload/download for docs previews. PR #516 by @tiangolo.
• ⬆ [pre-commit.ci] pre-commit autoupdate. PR #500 by @pre-commit-ci[bot].
• ⬆ Bump actions/cache from 2 to 3. PR #496 by @dependabot[bot].
• ⬆ Bump dawidd6/action-download-artifact from 2.24.1 to 2.24.2. PR #494 by @dependabot[bot].
• ⬆ Bump dawidd6/action-download-artifact from 2.9.0 to 2.24.1. PR #491 by @dependabot[bot].
• ⬆ Bump actions/setup-python from 2 to 4. PR #492 by @dependabot[bot].
• 👷‍♂️ Consistently use sys.executable to run subprocesses, needed by OpenSUSE. PR #408 by @theMarix.
• 👷‍♂️ Ensure the PYTHONPATH is set properly when testing the tutorial scripts. PR #407 by @theMarix.

0.7.0

Features

• ✨ Make typer.run() not add completion scripts by default, it only makes sense in installed apps. Also update docs for handling autocompletion in CLI options. PR #488 by @tiangolo.
• ✨ Add support for Python 3.11, tests in CI and official marker. PR #487 by @tiangolo.
• 👷 Add CI for Python 3.10. PR #384 by @tiangolo.

Fixes

• 🎨 Fix type annotation of typer.run(). PR #284 by @yassu.
• 🎨 Fix type annotations for get_group. PR #430 by @tiangolo.

Docs

• 📝 Add note about how subcommands with function names using underscores are converted to dashes. PR #403 by @targhs.
• 📝 Fix typo in docs at docs/tutorial/commands/help.md. PR #466 by @fepegar.
• ✏ Fix link in docs to datetime.strptime(). PR #464 by @Kobu.
• ✏ Update first-steps.md, clarify distinction between parameter and argument. PR #176 by @mccarthysean.
• ✏ Fix broken plac link. PR #275 by @mgielda.

Internal

• ✅ Add extra tests just for coverage because monkeypatching with strange imports confuses coverage. PR #490 by @tiangolo.
• 🔧 Tweak pytest coverage. PR #485 by @tiangolo.
• ➕ Bring back pytest-cov because coverage can't detect pytest-xdist. PR #484 by @tiangolo.
• ⬆ Bump actions/upload-artifact from 2 to 3. PR #477 by @dependabot[bot].
• ⬆ Bump actions/checkout from 2 to 3. PR #478 by @dependabot[bot].
• ⬆ [pre-commit.ci] pre-commit autoupdate. PR #411 by @pre-commit-ci[bot].
• ⬆ Bump nwtgck/actions-netlify from 1.1.5 to 1.2.4. PR #479 by @dependabot[bot].
• ⬆ Bump tiangolo/issue-manager from 0.2.0 to 0.4.0. PR #481 by @dependabot[bot].
• 👷 Move from pytest-cov to coverage and Codecov to Smokeshow. PR #483 by @tiangolo.
• ➕ Add extra Material for MkDocs deps for docs. PR #482 by @tiangolo.
• 🔧 Update Dependabot config. PR #476 by @tiangolo.

0.6.1

Fixes

• 🐛 Fix setting FORCE_TERMINAL with colors 2. PR #424 by @tiangolo.
• 🐛 Fix setting FORCE_TERMINAL with colors. PR #423 by @tiangolo.

0.6.0

This release adds deep integrations with Rich. ✨

rich is an optional dependency, you can install it directly or it will be included when you install with:

$ pip install "typer[all]"

If Rich is available, it will be used to show the content from --help options, validation errors, and even errors in your app (exception tracebacks).

There are new options to group commands, CLI arguments, and CLI options, support for Rich Console Markup, and more! 🎉

Features

• ✨ Richify, add integrations with Rich everywhere. PR #419 by @tiangolo.
  • Recommend Rich as the main information displaying tool, new docs: Printing and Colors.
  • For most use cases not using Rich, use plain print() instead of typer.echo() in the docs, to simplify the concepts and avoid confusions. New docs: Printing and Colors - typer Echo.
  • Define help panels for CLI arguments, new docs: CLI Arguments with Help - CLI Argument help panels.
  • Define help panels for CLI options, new docs: CLI Options with Help - CLI Options help panels.
  • New docs for deprecating commands: Commands - Command Help - Deprecate a Command.
  • Support for Rich Markdown in docstrings, CLI parameters help, and epilog with the new parameter typer.Typer(rich_markup_mode="markdown"), new docs: Commands - Command Help - Rich Markdown and Markup.
  • Support for Rich Markup (different from Markdown) in docstrings, CLI parameters help, and epilog with the new parameter typer.Typer(rich_markup_mode="rich"), new docs: Commands - Command Help - Rich Markdown and Markup.
  • Define help panels for commands, new docs: Commands - Command Help - Help Panels.
  • New docs for setting an epilog, with support for Rich Markdown and Console Markup, new docs: Commands - Command Help - Epilog.
• ✨ Refactor and document handling pretty exceptions. PR #422 by @tiangolo.
  • Add support for customizing pretty short errors, new docs: Exceptions and Errors.
• ✨ Allow configuring pretty errors when creating the Typer instance. PR #416 by @tiangolo.

Docs

• 📝 Add docs for using Rich with Typer. PR #421 by @tiangolo.
  • Add new docs: Ask with Prompt - Prompt with Rich.
  • Add new docs to handle progress bars and spinners with Rich: Progress Par.

Internal

• ⬆️ Upgrade codecov GitHub Action. PR #420 by @tiangolo.

0.5.0

Features

• ✨ Add pretty error tracebacks for user errors and support for Rich. PR #412 by @tiangolo.

Docs

• ✏ Fix typo, "ASCII codes" to "ANSI escape sequences". PR #308 by @septatrix.

0.4.2

Fixes

• 🐛 Fix type conversion for List and Tuple and their internal types. PR #143 by @hellowhistler.
• 🐛 Fix context_settings for a Typer app with a single command. PR #210 by @daddycocoaman.

Docs

• 📝 Clarify testing documentation about checking stderr. PR #335 by @cgabard.
• ✏ Fix typo in docs for CLI Option autocompletion. PR #288 by @graue70.
• 🎨 Fix header format for "Standard Input" in docs/tutorial/printing.md. PR #386 by @briancohan.
• ✏ Fix typo in docs/tutorial/terminating.md. PR #382 by @kianmeng.
• ✏ Fix syntax typo in docs/tutorial/package.md. PR #333 by @ryanstreur.
• ✏ Fix typo, duplicated word in docs/tutorial/options/required.md.. PR #316 by @michaelriri.
• ✏ Fix minor typo in index.md. PR #274 by @RmStorm.
• ✏ Fix double "and" typo in first-steps tutorial. PR #225 by @softwarebloat.
• 🎨 Fix format in docs explaining datetime parameter type. PR #220 by @DiegoPiloni.

Internal

• ⬆ [pre-commit.ci] pre-commit autoupdate. PR #404 by @pre-commit-ci[bot].
• 👷 Fix Material for MkDocs install in CI. PR #395 by @tiangolo.
• 👷 Add pre-commit CI config. PR #394 by @tiangolo.
• 👷 Clear MkDocs Insiders cache. PR #393 by @tiangolo.
• 🔧 Add pre-commit config and formatting. PR #392 by @tiangolo.
• 👷 Disable installing MkDocs Insiders in forks. PR #391 by @tiangolo.
• ⬆️ Upgrade Codecov GitHub Action. PR #383 by @tiangolo.

0.4.1

Fixes

• 🐛 Fix import of get_terminal_size for Click 8.1.0 support and upgrade Black to fix CI. PR #380 by @tiangolo based on original PR #375 by @madkinsz.

Internal

• 📝 Add Jina's QA Bot to the docs to help people that want to ask quick questions. PR #368 by @tiangolo.
• 💚 Only test on push when on master, avoid duplicate CI runs from PRs. PR #358 by @tiangolo.
• ✨ Add support for previewing docs in PRs from forks and enable MkDocs Insiders. PR #357 by @tiangolo.
• ⬆️ Upgrade MkDocs Material, MDX-Include, and MkDocs structure. PR #356 by @tiangolo.
• 👷 Update publish GitHub action. PR #325 by @tiangolo.

0.4.0

Features

• ✨ Add support for Click 8 while keeping compatibility with Click 7. PR #317 by @tiangolo.

Internal

• 📝 Add Security policy. PR #324 by @tiangolo.
• 🔧 Add updated issue templates. PR #323 by @tiangolo.
• 👷 Enable tests for Python 3.9. PR #322 by @tiangolo.
• 👷 Add GitHub Action Latest Changes. PR #321 by @tiangolo.
• 👷 Update docs CI name. PR #320 by @tiangolo.
• 🔧 Add sponsors docs and badge. PR #319 by @tiangolo.