Releases: fastapi/typer
0.12.0
In version 0.12.0
, the typer
package depends on typer-slim[standard]
which includes the default dependencies (instead of typer[all]
) and typer-cli
(that provides the typer
command).
If you don't want the extra optional dependencies (rich
and shellingham
), you can install typer-slim
instead.
You can also install typer-slim[standard]
, which includes the default optional dependencies, but not the typer
command.
In version 0.12.0
the typer-cli
package only provides the typer
command, but the code is still in the main code, so even without installing typer-cli
, it can be called with python -m typer
.
This approach of having typer
depend on typer-slim[standard]
instead of including the whole code and dependencies itself caused an issue when upgrading from typer <0.12.0
to typer >=0.12.0
, see issue #790. This is fixed in version 0.12.1
.
Features
- ✨ Add
typer-slim
package without extras, maketyper
includetyper-slim[default]
and integrate Typer CLI (typer
command) into Typer. PR #780 by @tiangolo.
Internal
0.11.1
0.11.0
Breaking Changes
- 🔧 Refactor package manager, move from Flit to PDM, remove private pip extras for
test
,doc
,dev
. PR #764 by @tiangolo. - 🔥 Remove support for Click 7, require Click 8+. PR #760 by @tiangolo.
- 🔥 Remove support for Python 3.6. PR #758 by @tiangolo.
Refactors
Internal
- ⬆️ Upgrade coverage and configs. PR #769 by @tiangolo.
- 🔧 Upgrade mypy and config. PR #768 by @tiangolo.
- 👷 Upgrade Smokeshow GitHub action. PR #767 by @tiangolo.
- 👷 Upgrade latest-changes GitHub Action. PR #766 by @tiangolo.
- 👷 Upgrade issue-manager GitHub Action. PR #765 by @tiangolo.
- 👷 Add alls-green to CI. PR #759 by @tiangolo.
0.10.0
0.9.4
0.9.3
0.9.2
Fixes
- 🐛 Fix display of default value for Enum parameters inside of a list, include docs and tests. PR #473 by @asieira.
- 🐛 Update type annotations for
show_default
parameter and update docs for setting a "Custom default string". PR #501 by @plannigan.
Docs
0.9.1
Fixes
- 🐛 Add missing
default_factory
inArgument
overloads. PR #750 by @m9810223. - 🐛 Fix preserving case in enum values. PR #571 by @avaldebe.
Docs
-
📝 Remove obsolete references to
--install-completion
fortyper.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
fortyper.Option()
andtyper.Argument()
. - All the docs have been updated to recommend
Annotated
.
Docs
- 📝 Update docs examples for custom param types using
Annotated
, fix overloads fortyper.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.