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.

0.3.2

Features

• Add support for mypy --strict. Original PR #147 by @victorphoenix3.

Docs

• Update docs with new --help showing default values. PR #135 by @victorphoenix3.
• Add Optional to docs for CLI Arguments and Options with a default of None. PR #131 by @rkbeatss.
• Add valid date formats to docs. PR #122 by @IamCathal.

Internal

• Report coverage in XML to support GitHub Actions. PR #146.
• Update badges and remove Travis, now that GitHub Actions is the main CI. PR #145.

0.3.1

• Add GitHub Actions, move from Travis. PR #144.
• Pin dependencies. PR #138.
• Add Dependabot. PR #136.
• Upgrade Isort to version 5.x.x. PR #137.

0.3.0

• Add support for help parameter in CLI arguments:
  • As help in CLI arguments is not supported by Click, there are two new internal classes (Click sub-classes) to support it:
    • typer.core.TyperArgument
    • typer.core.TyperCommand
  • This includes a new auto-generated help text section Arguments for CLI arguments, showing defaults, required arguments, etc.
  • It's also possible to disable it and keep the previous behavior, not showing automatic help for CLI arguments (Click's default) using the hidden parameter.
  • Now show_default is True by default.
  • And now show_envvar is True by default.
  • So, default values and env vars are shown in the help text by default, without having to manually enable them, for both CLI arguments and CLI options.
  • New docs:
    • CLI Arguments Intro.
    • Optional CLI Arguments.
    • CLI Arguments with Default.
    • CLI Arguments with Help.
    • CLI Arguments with Environment Variables.
    • CLI Arguments: Other uses.
    • CLI arguments with tuples.
  • Lot's of tests for all the new examples in the new docs, keeping coverage at 100%.
  • PR #123.
• Add docs for calling packages with python -m some_package using __main__.py: Building a Package: Support python -m. PR #121.
• Add support for *args and **kwargs when calling the Typer app, just like in Click. PR #120 by @teymour-aldridge.
• Fix typos in README and main docs #103 by @mrcartoonster.
• Fix typo in docs. PR #98 by @mrcartoonster.
• Fix typos and rewording in docs. PR #97 by @mrcartoonster.
• Update GitHub Action issue-manager. PR #114.

0.2.1

• Add support for forward references (types declared inside of strings). PR #93.