Typer
Latest Changes
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
0.3.2
Features
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:
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
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
0.0.7
0.0.6
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.