Releases: fastapi/typer
Releases · fastapi/typer
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
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 ofNone
. PR #131 by @rkbeatss. - Add valid date formats to docs. PR #122 by @IamCathal.
Internal
0.3.1
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
isTrue
by default. - And now
show_envvar
isTrue
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:
- Lot's of tests for all the new examples in the new docs, keeping coverage at 100%.
- PR #123.
- As
- Add docs for calling packages with
python -m some_package
using__main__.py
: Building a Package: Supportpython -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
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()
andprint()
for colors in Windows. PR #89. - Upgrade Mkdocs-Material version, update contributing guide style. PR #90.
0.1.1
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 byclick-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.
- If
- 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.
- Remove optional dependency
- 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.