typer/docs/release-notes.md

Latest Changes

• ✏ 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.
• 👷 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.

0.2.0

• Add support for completion for commands/programs not available on startup.
  • This allows installing a Typer program/script in a virtual environment and still have completion globally installed.
  • PR #92.
• Add note about typer.echo() and print() for colors in Windows. PR #89.
• Upgrade Mkdocs-Material version, update contributing guide style. PR #90.

0.1.1

• Fix completion evaluation for Bash and Zsh when the program is not installed/found. PR #83.
• Fix completion script for Fish. PR #82.
• Fix shell installation for Bash to ~/.bashrc and update Windows development docs. PR #81.
• Update coverage badge. PR #78.

0.1.0

• Fix coverage instructions. PR #72.
• Add docs for Building a Package. PR #71.
• Add docs for Using Click (with Typer). PR #70.
• Add support for type-based callbacks and autocompletion functions, extra tests and docs:
  • Extra tests, raising coverage to 100%.
  • New docs: Printing and Colors: "Standard Output" and "Standard Error".
  • New docs: Password CLI Option and Confirmation Prompt.
  • Support for callbacks based on type annotations. New docs: CLI Option Callback and Context.
  • New docs: Version CLI Option, is_eager.
  • Support for autocompletion functions based on type annotations. New docs: CLI Option autocompletion.
  • New docs: Commands: Using the Context.
  • New docs: Testing.
  • PR #68.
• Fix Zsh completion install script. PR #69.
• Fix typo in progressbar example. PR #63 by @ValentinCalomme.

0.0.11

• Re-implement completion system:
  • Remove optional dependency click-completion (with its sub-dependencies, like Jinja).
  • Add optional dependency shellingham to auto detect shell to install (it was used by click-completion).
  • Completion now doesn't require a third party library.
    • If shellingham is not installed/added as a dependency, --install-completion and --show-completion take a value with the name of the shell.
  • Fix support for user provided completion in CLI Parameters.
  • Fix completion for files in Bash, Zsh, and Fish.
  • Add support for modern versions of PowerShell, 5, 6, and 7 (e.g. in Windows 10).
  • Add support for pwsh (PowerShell Core).
    • PowerShell support includes help strings for commands and CLI Parameters.
  • Several bug fixes.
  • Tests for the completion logic/code.
  • Tested in all the shells in Linux and Windows.
  • PR #66.
• Fix format in docs with highlighted lines. PR #65.
• Add docs about Typer CLI - completion for small scripts. PR #64.
• Add docs about Alternatives, Inspiration and Comparisons. PR #62.
• Add Development - Contributing Guide. PR #61.

0.0.10

• Add support for Click version 7.1.1. PR #60.

0.0.9

• Add support for PEP 561, to allow mypy to type check applications built with Typer. PR #58.
• Upgrade deploy docs to Netlify GitHub action. PR #57.
• Add support for Mermaid JS for visualizations. PR #56.
• Update CI to run docs deployment in GitHub actions. PR #50.
• Update format for internal links. PR #38.
• Tweak external links' format. PR #36.

0.0.8

• Update docs and add latest changes to MkDocs/website. PR #33.
• Add extra tests for edge cases that don't belong in docs' examples. PR #32.
• Add docs for CLI Parameters with Multiple Values. Includes tests for all the examples and bug fixes. PR #31.
• Add docs for extra CLI parameter types: CLI Parameter Types: Number and CLI Parameter Types: Boolean CLI Options. PR #30.
• Extend docs for Commands, add Commands: Typer Callback and Commands: One or Multiple. This includes tests for all the examples and bug fixes. PR #29.
• Add docs for SubCommands - Command Groups. This includes tests for all the examples and bug fixes. PR #28.
• Remove unneeded code for argument handling. PR #26.
• Add docs for Launching Applications. PR #25.
• Add docs for getting the CLI Application Directory. PR #24.
• Add docs for Progress Bars. PR #23.
• Add docs for Asking with Interactive Prompts. PR #22.
• Update docs for path CLI option. PR #21.
• Add colors module and docs for Printing and Colors and for Terminating, including tests. PR #20.
• Refactor docs to make each individual page/section "bite-sized" / small. Add docs for CLI option names. Update typer.Argument() to remove invalid positional param_decls. PR #19.

0.0.7

• Add docs for CLI parameter types. Includes tests and file classes refactor. PR #17.
• Add tests for completion. PR #15 and #16.

0.0.6

• Add docs for Commands. Includes a bug fix for handling default values set in typer.Typer() parameters. PR #14.
• Add docs for CLI Arguments. PR #13.
• Add docs for CLI Options. PR #12.

0.0.5

• Clean exports from Typer. Remove unneeded components from Click and add needed Exit exception. PR #11.
• Fix and document extracting help from a function's docstring First Steps: Document your CLI app. PR #10.
• Update references to --install-completion and --show-completion in docs. PR #9.
• Fix testing utilities, add tests for First Steps examples. PR #8.
• Add auto completion options by default when click-completion is installed: --install-completion and --show-completion. PR #7.
• Update Termynal to have fixed sizes, add "fast" button, and use it in First Steps. PR #6.
• Add custom automatic Termynal for docs. PR #5.

0.0.4

• Update short descriptions and assets.
• Docs rewording and fix typos. PR #1 by @mariacamilagl.

0.0.3

• Fix group creation without name.

0.0.2

• Add initial version of code, docs, etc.

0.0.1

• First commit. Publish to PyPI to reserve package name.