typer/docs/release-notes.md

397 lines
33 KiB
Markdown
Raw Normal View History

2021-08-30 10:25:37 +02:00
## Latest Changes
2019-12-24 13:31:59 +01:00
2023-10-29 10:11:41 +01:00
* 👷 Install MkDocs Material Insiders only when secrets are available, for Dependabot. PR [#685](https://github.com/tiangolo/typer/pull/685) by [@tiangolo](https://github.com/tiangolo).
2023-08-01 11:36:09 +02:00
* ⚒️ Update build-docs.yml, do not zip docs. PR [#645](https://github.com/tiangolo/typer/pull/645) by [@tiangolo](https://github.com/tiangolo).
2023-08-01 11:17:48 +02:00
* 👷 Deploy docs to Cloudflare. PR [#644](https://github.com/tiangolo/typer/pull/644) by [@tiangolo](https://github.com/tiangolo).
2023-07-31 18:10:25 +02:00
* 👷 Upgrade CI for docs. PR [#642](https://github.com/tiangolo/typer/pull/642) by [@tiangolo](https://github.com/tiangolo).
2023-07-31 18:07:09 +02:00
* 👷 Update token for latest changes. PR [#635](https://github.com/tiangolo/typer/pull/635) by [@tiangolo](https://github.com/tiangolo).
2023-07-31 18:06:43 +02:00
* 👷 Update CI workflow dispatch for latest changes. PR [#643](https://github.com/tiangolo/typer/pull/643) by [@tiangolo](https://github.com/tiangolo).
2023-07-31 18:02:42 +02:00
* 👷 Update token for Material for MkDocs Insiders. PR [#636](https://github.com/tiangolo/typer/pull/636) by [@tiangolo](https://github.com/tiangolo).
2023-07-31 17:59:12 +02:00
* 🐛 Fix internal type annotations and bump mypy version. PR [#638](https://github.com/tiangolo/typer/pull/638) by [@paulo-raca](https://github.com/paulo-raca).
2023-05-02 08:15:57 +02:00
* 📝 Remove obsolete references to `--install-completion` for `typer.run()` scripts. PR [#595](https://github.com/tiangolo/typer/pull/595) by [@tiangolo](https://github.com/tiangolo).
2023-05-02 07:14:19 +02:00
## 0.9.0
2023-05-02 07:12:51 +02:00
### Features
* ✨ Add support for PEP-593 `Annotated` for specifying options and arguments. Initial PR [#584](https://github.com/tiangolo/typer/pull/584) by [@ryangalamb](https://github.com/ryangalamb).
* New docs: [Optional CLI arguments](https://typer.tiangolo.com/tutorial/arguments/optional/#an-alternative-cli-argument-declaration).
* 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` for `typer.Option()` and `typer.Argument()`.
* All the docs have been updated to recommend `Annotated`.
### Docs
2023-05-02 07:03:35 +02:00
* 📝 Update docs examples for custom param types using `Annotated`, fix overloads for `typer.Argument`. PR [#594](https://github.com/tiangolo/typer/pull/594) by [@tiangolo](https://github.com/tiangolo).
2023-05-01 12:59:15 +02:00
2023-05-02 07:12:51 +02:00
### Internal
* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#592](https://github.com/tiangolo/typer/pull/592) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
2023-05-01 13:29:07 +02:00
## 0.8.0
2023-05-01 12:59:15 +02:00
### Features
* ✨ Add support for custom types and parsers. Initial PR [#583](https://github.com/tiangolo/typer/pull/583) by [@jpurviance](https://github.com/jpurviance). Based on original PR [#443](https://github.com/tiangolo/typer/pull/443) by [@paulo-raca](https://github.com/paulo-raca).
* New docs: [CLI Parameter Types: Custom Types](https://typer.tiangolo.com/tutorial/parameter-types/custom-types/).
2023-05-01 13:27:06 +02:00
### Upgrades
* ⬆ Upgrade Rich, support 13.x. PR [#524](https://github.com/tiangolo/typer/pull/524) by [@musicinmybrain](https://github.com/musicinmybrain).
2023-05-01 12:59:15 +02:00
### Docs
2023-05-01 12:52:11 +02:00
* 📝 Tweak docs, Custom Types path, main page and READAME colors, broken links. PR [#588](https://github.com/tiangolo/typer/pull/588) by [@tiangolo](https://github.com/tiangolo).
2023-05-01 13:27:06 +02:00
* ✏ Fix spelling (shinny -> shiny). PR [#586](https://github.com/tiangolo/typer/pull/586) by [@runofthemill](https://github.com/runofthemill).
2023-05-01 12:59:15 +02:00
* 📝 Update docs about helping Typer. PR [#547](https://github.com/tiangolo/typer/pull/547) by [@tiangolo](https://github.com/tiangolo).
* ✏️ Fix typo in datetime docs. PR [#495](https://github.com/tiangolo/typer/pull/495) by [@huxuan](https://github.com/huxuan).
* ✏️ Add quotes to package name that includes brackets in docs. PR [#475](https://github.com/tiangolo/typer/pull/475) by [@gjolga](https://github.com/gjolga).
### Internal
2023-05-01 13:27:06 +02:00
* ⬆ Bump dawidd6/action-download-artifact from 2.24.2 to 2.26.0. PR [#558](https://github.com/tiangolo/typer/pull/558) by [@dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#549](https://github.com/tiangolo/typer/pull/549) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
2023-04-26 01:30:29 +02:00
* 🔧 Add `exclude_lines` to coverage configuration. PR [#585](https://github.com/tiangolo/typer/pull/585) by [@dmontagu](https://github.com/dmontagu).
2023-02-21 12:05:36 +01:00
* ⬆️ Upgrade analytics. PR [#557](https://github.com/tiangolo/typer/pull/557) by [@tiangolo](https://github.com/tiangolo).
2023-01-31 15:11:55 +01:00
* 🔧 Update new issue chooser to suggest GitHub Discussions. PR [#544](https://github.com/tiangolo/typer/pull/544) by [@tiangolo](https://github.com/tiangolo).
2023-01-30 11:35:54 +01:00
* 🔧 Add GitHub Discussion templates for questions. PR [#541](https://github.com/tiangolo/typer/pull/541) by [@tiangolo](https://github.com/tiangolo).
2023-01-30 11:29:22 +01:00
* 🔧 Update pre-commit, Python version, isort version. PR [#542](https://github.com/tiangolo/typer/pull/542) by [@tiangolo](https://github.com/tiangolo).
2022-12-17 00:10:44 +01:00
* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#512](https://github.com/tiangolo/typer/pull/512) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
2022-12-16 21:46:01 +01:00
* ⬆ Bump nwtgck/actions-netlify from 1.2.4 to 2.0.0. PR [#513](https://github.com/tiangolo/typer/pull/513) by [@dependabot[bot]](https://github.com/apps/dependabot).
2022-12-16 19:29:42 +01:00
* 👷 Refactor CI artifact upload/download for docs previews. PR [#516](https://github.com/tiangolo/typer/pull/516) by [@tiangolo](https://github.com/tiangolo).
2022-11-14 22:52:28 +01:00
* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#500](https://github.com/tiangolo/typer/pull/500) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
2022-11-11 13:33:26 +01:00
* ⬆ Bump actions/cache from 2 to 3. PR [#496](https://github.com/tiangolo/typer/pull/496) by [@dependabot[bot]](https://github.com/apps/dependabot).
2022-11-10 11:28:41 +01:00
* ⬆ Bump dawidd6/action-download-artifact from 2.24.1 to 2.24.2. PR [#494](https://github.com/tiangolo/typer/pull/494) by [@dependabot[bot]](https://github.com/apps/dependabot).
2022-11-09 12:49:18 +01:00
* ⬆ Bump dawidd6/action-download-artifact from 2.9.0 to 2.24.1. PR [#491](https://github.com/tiangolo/typer/pull/491) by [@dependabot[bot]](https://github.com/apps/dependabot).
2022-11-09 12:47:34 +01:00
* ⬆ Bump actions/setup-python from 2 to 4. PR [#492](https://github.com/tiangolo/typer/pull/492) by [@dependabot[bot]](https://github.com/apps/dependabot).
2022-11-07 19:02:28 +01:00
* 👷‍♂️ Consistently use `sys.executable` to run subprocesses, needed by OpenSUSE. PR [#408](https://github.com/tiangolo/typer/pull/408) by [@theMarix](https://github.com/theMarix).
2022-11-07 18:54:14 +01:00
* 👷‍♂️ Ensure the `PYTHONPATH` is set properly when testing the tutorial scripts. PR [#407](https://github.com/tiangolo/typer/pull/407) by [@theMarix](https://github.com/theMarix).
2022-11-05 17:18:01 +01:00
2022-11-05 20:37:40 +01:00
## 0.7.0
2022-11-05 17:18:01 +01:00
### Features
* ✨ Make `typer.run()` not add completion scripts by default, it only makes sense in installed apps. Also update docs for handling [autocompletion in CLI options](https://typer.tiangolo.com/tutorial/options-autocompletion/). PR [#488](https://github.com/tiangolo/typer/pull/488) by [@tiangolo](https://github.com/tiangolo).
2022-11-05 15:51:19 +01:00
* ✨ Add support for Python 3.11, tests in CI and official marker. PR [#487](https://github.com/tiangolo/typer/pull/487) by [@tiangolo](https://github.com/tiangolo).
2022-11-05 15:43:19 +01:00
* 👷 Add CI for Python 3.10. PR [#384](https://github.com/tiangolo/typer/pull/384) by [@tiangolo](https://github.com/tiangolo).
2022-11-05 17:18:01 +01:00
### Fixes
2022-11-05 15:41:32 +01:00
* 🎨 Fix type annotation of `typer.run()`. PR [#284](https://github.com/tiangolo/typer/pull/284) by [@yassu](https://github.com/yassu).
2022-11-05 17:18:01 +01:00
* 🎨 Fix type annotations for `get_group`. PR [#430](https://github.com/tiangolo/typer/pull/430) by [@tiangolo](https://github.com/tiangolo).
### Docs
2022-11-05 15:39:43 +01:00
* 📝 Add note about how subcommands with function names using underscores are converted to dashes. PR [#403](https://github.com/tiangolo/typer/pull/403) by [@targhs](https://github.com/targhs).
2022-11-05 15:35:10 +01:00
* 📝 Fix typo in docs at `docs/tutorial/commands/help.md`. PR [#466](https://github.com/tiangolo/typer/pull/466) by [@fepegar](https://github.com/fepegar).
2022-11-05 15:32:46 +01:00
* ✏ Fix link in docs to `datetime.strptime()`. PR [#464](https://github.com/tiangolo/typer/pull/464) by [@Kobu](https://github.com/Kobu).
2022-11-05 17:18:01 +01:00
* ✏ Update `first-steps.md`, clarify distinction between parameter and argument. PR [#176](https://github.com/tiangolo/typer/pull/176) by [@mccarthysean](https://github.com/mccarthysean).
* ✏ Fix broken plac link. PR [#275](https://github.com/tiangolo/typer/pull/275) by [@mgielda](https://github.com/mgielda).
### Internal
2022-11-05 20:24:18 +01:00
* ✅ Add extra tests just for coverage because monkeypatching with strange imports confuses coverage. PR [#490](https://github.com/tiangolo/typer/pull/490) by [@tiangolo](https://github.com/tiangolo).
2022-11-05 15:26:11 +01:00
* 🔧 Tweak pytest coverage. PR [#485](https://github.com/tiangolo/typer/pull/485) by [@tiangolo](https://github.com/tiangolo).
2022-11-05 02:02:46 +01:00
* Bring back pytest-cov because coverage can't detect pytest-xdist. PR [#484](https://github.com/tiangolo/typer/pull/484) by [@tiangolo](https://github.com/tiangolo).
2022-11-05 01:13:46 +01:00
* ⬆ Bump actions/upload-artifact from 2 to 3. PR [#477](https://github.com/tiangolo/typer/pull/477) by [@dependabot[bot]](https://github.com/apps/dependabot).
2022-11-05 01:13:18 +01:00
* ⬆ Bump actions/checkout from 2 to 3. PR [#478](https://github.com/tiangolo/typer/pull/478) by [@dependabot[bot]](https://github.com/apps/dependabot).
2022-11-05 01:11:48 +01:00
* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#411](https://github.com/tiangolo/typer/pull/411) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
2022-11-05 01:10:43 +01:00
* ⬆ Bump nwtgck/actions-netlify from 1.1.5 to 1.2.4. PR [#479](https://github.com/tiangolo/typer/pull/479) by [@dependabot[bot]](https://github.com/apps/dependabot).
2022-11-05 01:10:21 +01:00
* ⬆ Bump tiangolo/issue-manager from 0.2.0 to 0.4.0. PR [#481](https://github.com/tiangolo/typer/pull/481) by [@dependabot[bot]](https://github.com/apps/dependabot).
2022-11-05 00:09:07 +01:00
* 👷 Move from pytest-cov to coverage and Codecov to Smokeshow. PR [#483](https://github.com/tiangolo/typer/pull/483) by [@tiangolo](https://github.com/tiangolo).
2022-11-04 22:43:51 +01:00
* Add extra Material for MkDocs deps for docs. PR [#482](https://github.com/tiangolo/typer/pull/482) by [@tiangolo](https://github.com/tiangolo).
2022-11-04 20:59:37 +01:00
* 🔧 Update Dependabot config. PR [#476](https://github.com/tiangolo/typer/pull/476) by [@tiangolo](https://github.com/tiangolo).
2022-07-12 22:26:29 +02:00
## 0.6.1
### Fixes
2022-07-12 22:24:39 +02:00
* 🐛 Fix setting `FORCE_TERMINAL` with colors 2. PR [#424](https://github.com/tiangolo/typer/pull/424) by [@tiangolo](https://github.com/tiangolo).
2022-07-12 22:18:30 +02:00
* 🐛 Fix setting `FORCE_TERMINAL` with colors. PR [#423](https://github.com/tiangolo/typer/pull/423) by [@tiangolo](https://github.com/tiangolo).
2022-07-12 22:26:29 +02:00
2022-07-12 21:53:01 +02:00
## 0.6.0
2022-07-12 21:55:47 +02:00
This release adds deep integrations with [Rich](https://rich.readthedocs.io/en/stable/). ✨
2022-07-12 21:52:20 +02:00
`rich` is an optional dependency, you can install it directly or it will be included when you install with:
```console
$ 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](https://rich.readthedocs.io/en/stable/markup.html), and more! 🎉
### Features
* ✨ Richify, add integrations with Rich everywhere. PR [#419](https://github.com/tiangolo/typer/pull/419) by [@tiangolo](https://github.com/tiangolo).
* Recommend Rich as the main information displaying tool, new docs: [Printing and Colors](https://typer.tiangolo.com/tutorial/printing/).
* 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](https://typer.tiangolo.com/tutorial/printing/#typer-echo).
* Define help panels for *CLI arguments*, new docs: [CLI Arguments with Help - CLI Argument help panels](https://typer.tiangolo.com/tutorial/arguments/help/#cli-argument-help-panels).
* Define help panels for *CLI options*, new docs: [CLI Options with Help - CLI Options help panels](https://typer.tiangolo.com/tutorial/options/help/#cli-options-help-panels).
* New docs for deprecating commands: [Commands - Command Help - Deprecate a Command](https://typer.tiangolo.com/tutorial/commands/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](https://typer.tiangolo.com/tutorial/commands/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](https://typer.tiangolo.com/tutorial/commands/help/#rich-markdown-and-markup).
* Define help panels for *commands*, new docs: [Commands - Command Help - Help Panels](https://typer.tiangolo.com/tutorial/commands/help/#help-panels).
* New docs for setting an `epilog`, with support for Rich Markdown and Console Markup, new docs: [Commands - Command Help - Epilog](https://typer.tiangolo.com/tutorial/commands/help/#epilog).
2022-07-12 21:07:37 +02:00
* ✨ Refactor and document handling pretty exceptions. PR [#422](https://github.com/tiangolo/typer/pull/422) by [@tiangolo](https://github.com/tiangolo).
2022-07-12 21:52:20 +02:00
* Add support for customizing pretty short errors, new docs: [Exceptions and Errors](https://typer.tiangolo.com/tutorial/exceptions/).
* ✨ Allow configuring pretty errors when creating the Typer instance. PR [#416](https://github.com/tiangolo/typer/pull/416) by [@tiangolo](https://github.com/tiangolo).
### Docs
2022-07-12 20:39:28 +02:00
* 📝 Add docs for using Rich with Typer. PR [#421](https://github.com/tiangolo/typer/pull/421) by [@tiangolo](https://github.com/tiangolo).
2022-07-12 21:52:20 +02:00
* Add new docs: [Ask with Prompt - Prompt with Rich](https://typer.tiangolo.com/tutorial/prompt/#prompt-with-rich).
* Add new docs to handle progress bars and spinners with Rich: [Progress Par](https://typer.tiangolo.com/tutorial/progressbar/).
### Internal
2022-07-12 18:54:34 +02:00
* ⬆️ Upgrade codecov GitHub Action. PR [#420](https://github.com/tiangolo/typer/pull/420) by [@tiangolo](https://github.com/tiangolo).
2022-07-06 20:50:08 +02:00
2022-07-06 20:51:33 +02:00
## 0.5.0
2022-07-06 20:50:08 +02:00
### Features
2022-07-06 13:32:59 +02:00
* ✨ Add pretty error tracebacks for user errors and support for Rich. PR [#412](https://github.com/tiangolo/typer/pull/412) by [@tiangolo](https://github.com/tiangolo).
2022-07-06 20:50:08 +02:00
### Docs
2022-07-04 11:21:05 +02:00
* ✏ Fix typo, "ASCII codes" to "ANSI escape sequences". PR [#308](https://github.com/tiangolo/typer/pull/308) by [@septatrix](https://github.com/septatrix).
2022-07-02 19:59:21 +02:00
2022-07-02 20:02:12 +02:00
## 0.4.2
2022-07-02 19:59:21 +02:00
### Fixes
2022-07-02 19:26:33 +02:00
* 🐛 Fix type conversion for `List` and `Tuple` and their internal types. PR [#143](https://github.com/tiangolo/typer/pull/143) by [@hellowhistler](https://github.com/hellowhistler).
2022-07-02 18:37:37 +02:00
* 🐛 Fix `context_settings` for a Typer app with a single command. PR [#210](https://github.com/tiangolo/typer/pull/210) by [@daddycocoaman](https://github.com/daddycocoaman).
2022-07-02 19:59:21 +02:00
### Docs
* 📝 Clarify testing documentation about checking `stderr`. PR [#335](https://github.com/tiangolo/typer/pull/335) by [@cgabard](https://github.com/cgabard).
2022-05-12 21:20:12 +02:00
* ✏ Fix typo in docs for CLI Option autocompletion. PR [#288](https://github.com/tiangolo/typer/pull/288) by [@graue70](https://github.com/graue70).
2022-05-12 21:17:38 +02:00
* 🎨 Fix header format for "Standard Input" in `docs/tutorial/printing.md`. PR [#386](https://github.com/tiangolo/typer/pull/386) by [@briancohan](https://github.com/briancohan).
2022-05-12 21:16:05 +02:00
* ✏ Fix typo in `docs/tutorial/terminating.md`. PR [#382](https://github.com/tiangolo/typer/pull/382) by [@kianmeng](https://github.com/kianmeng).
2022-05-12 21:14:20 +02:00
* ✏ Fix syntax typo in `docs/tutorial/package.md`. PR [#333](https://github.com/tiangolo/typer/pull/333) by [@ryanstreur](https://github.com/ryanstreur).
2022-05-12 21:13:33 +02:00
* ✏ Fix typo, duplicated word in `docs/tutorial/options/required.md`.. PR [#316](https://github.com/tiangolo/typer/pull/316) by [@michaelriri](https://github.com/michaelriri).
2022-05-12 21:08:00 +02:00
* ✏ Fix minor typo in `index.md`. PR [#274](https://github.com/tiangolo/typer/pull/274) by [@RmStorm](https://github.com/RmStorm).
2022-05-12 21:06:24 +02:00
* ✏ Fix double "and" typo in first-steps tutorial. PR [#225](https://github.com/tiangolo/typer/pull/225) by [@softwarebloat](https://github.com/softwarebloat).
2022-05-12 21:03:04 +02:00
* 🎨 Fix format in docs explaining `datetime` parameter type. PR [#220](https://github.com/tiangolo/typer/pull/220) by [@DiegoPiloni](https://github.com/DiegoPiloni).
2022-07-02 19:59:21 +02:00
### Internal
* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#404](https://github.com/tiangolo/typer/pull/404) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
2022-05-12 19:53:48 +02:00
* 👷 Fix Material for MkDocs install in CI. PR [#395](https://github.com/tiangolo/typer/pull/395) by [@tiangolo](https://github.com/tiangolo).
2022-05-12 19:12:44 +02:00
* 👷 Add pre-commit CI config. PR [#394](https://github.com/tiangolo/typer/pull/394) by [@tiangolo](https://github.com/tiangolo).
2022-05-12 03:11:19 +02:00
* 👷 Clear MkDocs Insiders cache. PR [#393](https://github.com/tiangolo/typer/pull/393) by [@tiangolo](https://github.com/tiangolo).
2022-05-12 03:00:33 +02:00
* 🔧 Add pre-commit config and formatting. PR [#392](https://github.com/tiangolo/typer/pull/392) by [@tiangolo](https://github.com/tiangolo).
2022-05-12 01:14:18 +02:00
* 👷 Disable installing MkDocs Insiders in forks. PR [#391](https://github.com/tiangolo/typer/pull/391) by [@tiangolo](https://github.com/tiangolo).
2022-04-16 10:21:38 +02:00
* ⬆️ Upgrade Codecov GitHub Action. PR [#383](https://github.com/tiangolo/typer/pull/383) by [@tiangolo](https://github.com/tiangolo).
2022-07-02 19:59:21 +02:00
2022-03-30 21:15:11 +02:00
## 0.4.1
2022-03-30 21:14:38 +02:00
### Fixes
* 🐛 Fix import of `get_terminal_size` for Click 8.1.0 support and upgrade Black to fix CI. PR [#380](https://github.com/tiangolo/typer/pull/380) by [@tiangolo](https://github.com/tiangolo) based on original PR [#375](https://github.com/tiangolo/typer/pull/375) by [@madkinsz](https://github.com/madkinsz).
### Internal
2022-03-05 20:04:50 +01:00
* 📝 Add Jina's QA Bot to the docs to help people that want to ask quick questions. PR [#368](https://github.com/tiangolo/typer/pull/368) by [@tiangolo](https://github.com/tiangolo).
2022-02-13 18:08:15 +01:00
* 💚 Only test on push when on master, avoid duplicate CI runs from PRs. PR [#358](https://github.com/tiangolo/typer/pull/358) by [@tiangolo](https://github.com/tiangolo).
2022-02-13 18:02:27 +01:00
* ✨ Add support for previewing docs in PRs from forks and enable MkDocs Insiders. PR [#357](https://github.com/tiangolo/typer/pull/357) by [@tiangolo](https://github.com/tiangolo).
2022-02-13 17:36:27 +01:00
* ⬆️ Upgrade MkDocs Material, MDX-Include, and MkDocs structure. PR [#356](https://github.com/tiangolo/typer/pull/356) by [@tiangolo](https://github.com/tiangolo).
2021-08-30 11:02:44 +02:00
* 👷 Update publish GitHub action. PR [#325](https://github.com/tiangolo/typer/pull/325) by [@tiangolo](https://github.com/tiangolo).
2021-08-30 10:53:49 +02:00
## 0.4.0
### Features
2021-08-30 10:53:49 +02:00
* ✨ Add support for Click 8 while keeping compatibility with Click 7. PR [#317](https://github.com/tiangolo/typer/pull/317) by [@tiangolo](https://github.com/tiangolo).
### Internal
2021-08-30 10:51:18 +02:00
* 📝 Add Security policy. PR [#324](https://github.com/tiangolo/typer/pull/324) by [@tiangolo](https://github.com/tiangolo).
2021-08-30 10:50:51 +02:00
* 🔧 Add updated issue templates. PR [#323](https://github.com/tiangolo/typer/pull/323) by [@tiangolo](https://github.com/tiangolo).
2021-08-30 10:31:19 +02:00
* 👷 Enable tests for Python 3.9. PR [#322](https://github.com/tiangolo/typer/pull/322) by [@tiangolo](https://github.com/tiangolo).
2021-08-30 10:30:21 +02:00
* 👷 Add GitHub Action Latest Changes. PR [#321](https://github.com/tiangolo/typer/pull/321) by [@tiangolo](https://github.com/tiangolo).
2021-08-30 10:29:32 +02:00
* 👷 Update docs CI name. PR [#320](https://github.com/tiangolo/typer/pull/320) by [@tiangolo](https://github.com/tiangolo).
2021-08-30 10:28:46 +02:00
* 🔧 Add sponsors docs and badge. PR [#319](https://github.com/tiangolo/typer/pull/319) by [@tiangolo](https://github.com/tiangolo).
2021-08-30 10:31:35 +02:00
2020-08-16 16:52:47 +02:00
## 0.3.2
2020-08-16 16:41:10 +02:00
### Features
* Add support for `mypy --strict`. Original PR [#147](https://github.com/tiangolo/typer/pull/147) by [@victorphoenix3](https://github.com/victorphoenix3).
2020-08-16 14:04:50 +02:00
### Docs
2020-08-16 14:21:17 +02:00
* Update docs with new `--help` showing default values. PR [#135](https://github.com/tiangolo/typer/pull/135) by [@victorphoenix3](https://github.com/victorphoenix3).
2020-08-16 14:04:50 +02:00
* Add `Optional` to docs for *CLI Arguments and Options* with a default of `None`. PR [#131](https://github.com/tiangolo/typer/pull/131) by [@rkbeatss](https://github.com/rkbeatss).
2020-08-16 13:34:01 +02:00
* Add valid date formats to docs. PR [#122](https://github.com/tiangolo/typer/pull/122) by [@IamCathal](https://github.com/IamCathal).
2020-08-16 14:04:50 +02:00
### Internal
2020-07-19 14:38:34 +02:00
* Report coverage in XML to support GitHub Actions. PR [#146](https://github.com/tiangolo/typer/pull/146).
2020-07-19 13:28:37 +02:00
* Update badges and remove Travis, now that GitHub Actions is the main CI. PR [#145](https://github.com/tiangolo/typer/pull/145).
2020-07-19 13:07:28 +02:00
## 0.3.1
2020-07-19 13:05:37 +02:00
* Add GitHub Actions, move from Travis. PR [#144](https://github.com/tiangolo/typer/pull/144).
2020-07-09 23:47:55 +02:00
* Pin dependencies. PR [#138](https://github.com/tiangolo/typer/pull/138).
2020-07-09 23:23:19 +02:00
* Add Dependabot. PR [#136](https://github.com/tiangolo/typer/pull/136).
2020-07-09 22:10:45 +02:00
* Upgrade Isort to version 5.x.x. PR [#137](https://github.com/tiangolo/typer/pull/137).
2020-06-24 21:21:08 +02:00
## 0.3.0
2020-06-24 21:20:15 +02:00
* 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](https://typer.tiangolo.com/tutorial/arguments/).
* [Optional CLI Arguments](https://typer.tiangolo.com/tutorial/arguments/optional/).
* [CLI Arguments with Default](https://typer.tiangolo.com/tutorial/arguments/default/).
* [CLI Arguments with Help](https://typer.tiangolo.com/tutorial/arguments/help/).
* [CLI Arguments with Environment Variables](https://typer.tiangolo.com/tutorial/arguments/envvar/).
* [CLI Arguments: Other uses](https://typer.tiangolo.com/tutorial/arguments/other-uses/).
* [CLI arguments with tuples](https://typer.tiangolo.com/tutorial/multiple-values/arguments-with-multiple-values/#cli-arguments-with-tuples).
* Lot's of tests for all the new examples in the new docs, keeping coverage at 100%.
* PR [#123](https://github.com/tiangolo/typer/pull/123).
2020-06-23 14:54:34 +02:00
* Add docs for calling packages with `python -m some_package` using `__main__.py`: [Building a Package: Support `python -m`](https://typer.tiangolo.com/tutorial/package/#support-python-m-optional). PR [#121](https://github.com/tiangolo/typer/pull/121).
2020-06-23 14:42:03 +02:00
* Add support for `*args` and `**kwargs` when calling the Typer app, just like in Click. PR [#120](https://github.com/tiangolo/typer/pull/120) by [@teymour-aldridge](https://github.com/teymour-aldridge).
2020-06-22 19:54:41 +02:00
* Fix typos in README and main docs [#103](https://github.com/tiangolo/typer/pull/103) by [@mrcartoonster](https://github.com/mrcartoonster).
2020-06-22 19:27:25 +02:00
* Fix typo in docs. PR [#98](https://github.com/tiangolo/typer/pull/98) by [@mrcartoonster](https://github.com/mrcartoonster).
2020-06-22 19:04:28 +02:00
* Fix typos and rewording in docs. PR [#97](https://github.com/tiangolo/typer/pull/97) by [@mrcartoonster](https://github.com/mrcartoonster).
2020-06-06 14:30:16 +02:00
* Update GitHub Action issue-manager. PR [#114](https://github.com/tiangolo/typer/pull/114).
2020-04-26 15:48:56 +02:00
## 0.2.1
2020-04-26 15:43:19 +02:00
* Add support for forward references (types declared inside of strings). PR [#93](https://github.com/tiangolo/typer/pull/93).
2020-04-26 12:50:20 +02:00
## 0.2.0
2020-04-26 12:20:16 +02:00
* 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](https://github.com/tiangolo/typer/pull/92).
2020-04-18 12:47:51 +02:00
* Add note about `typer.echo()` and `print()` for colors in Windows. PR [#89](https://github.com/tiangolo/typer/pull/89).
* Upgrade Mkdocs-Material version, update contributing guide style. PR [#90](https://github.com/tiangolo/typer/pull/90).
2020-04-18 12:39:48 +02:00
2020-03-29 15:44:09 +02:00
## 0.1.1
2020-03-29 15:41:53 +02:00
* Fix completion evaluation for Bash and Zsh when the program is not installed/found. PR [#83](https://github.com/tiangolo/typer/pull/83).
* Fix completion script for Fish. PR [#82](https://github.com/tiangolo/typer/pull/82).
2020-03-29 14:30:04 +02:00
* Fix shell installation for Bash to `~/.bashrc` and update Windows development docs. PR [#81](https://github.com/tiangolo/typer/pull/81).
2020-03-27 18:16:09 +01:00
* Update coverage badge. PR [#78](https://github.com/tiangolo/typer/pull/78).
2020-03-19 14:50:02 +01:00
## 0.1.0
2020-03-19 14:45:16 +01:00
* Fix coverage instructions. PR [#72](https://github.com/tiangolo/typer/pull/72).
* Add docs for [Building a Package](https://typer.tiangolo.com/tutorial/package/). PR [#71](https://github.com/tiangolo/typer/pull/71).
2020-03-19 10:31:07 +01:00
* Add docs for [Using Click (with Typer)](https://typer.tiangolo.com/tutorial/using-click/). PR [#70](https://github.com/tiangolo/typer/pull/70).
2020-03-19 08:48:35 +01:00
* 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"](https://typer.tiangolo.com/tutorial/printing/#standard-output-and-standard-error).
* New docs: [Password CLI Option and Confirmation Prompt](https://typer.tiangolo.com/tutorial/options/password/).
2020-03-19 14:55:15 +01:00
* Support for callbacks based on type annotations. New docs: [CLI Option Callback and Context](https://typer.tiangolo.com/tutorial/options/callback-and-context/).
2020-03-19 08:48:35 +01:00
* New docs: [Version CLI Option, is_eager](https://typer.tiangolo.com/tutorial/options/version/).
* Support for autocompletion functions based on type annotations. New docs: [CLI Option autocompletion](https://typer.tiangolo.com/tutorial/options/autocompletion/).
* New docs: [Commands: Using the Context](https://typer.tiangolo.com/tutorial/commands/context/).
* New docs: [Testing](https://typer.tiangolo.com/tutorial/testing/).
* PR [#68](https://github.com/tiangolo/typer/pull/68).
* Fix Zsh completion install script. PR [#69](https://github.com/tiangolo/typer/pull/69).
* Fix typo in progressbar example. PR [#63](https://github.com/tiangolo/typer/pull/63) by [@ValentinCalomme](https://github.com/ValentinCalomme).
2020-03-16 13:24:10 +01:00
## 0.0.11
2020-03-16 13:23:10 +01:00
* 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](https://github.com/tiangolo/typer/pull/66).
2020-03-12 10:47:07 +01:00
* Fix format in docs with highlighted lines. PR [#65](https://github.com/tiangolo/typer/pull/65).
2020-03-11 17:17:49 +01:00
* Add docs about [Typer CLI - completion for small scripts](https://typer.tiangolo.com/typer-cli/). PR [#64](https://github.com/tiangolo/typer/pull/64).
2020-03-11 12:15:24 +01:00
* Add docs about [Alternatives, Inspiration and Comparisons](https://typer.tiangolo.com/alternatives/). PR [#62](https://github.com/tiangolo/typer/pull/62).
* Add [Development - Contributing Guide](https://typer.tiangolo.com/contributing/). PR [#61](https://github.com/tiangolo/typer/pull/61).
2020-03-10 18:51:38 +01:00
## 0.0.10
2020-03-10 18:50:47 +01:00
* Add support for Click version 7.1.1. PR [#60](https://github.com/tiangolo/typer/pull/60).
2020-03-08 19:12:31 +01:00
## 0.0.9
2020-03-08 19:11:54 +01:00
* Add support for PEP 561, to allow `mypy` to type check applications built with **Typer**. PR [#58](https://github.com/tiangolo/typer/pull/58).
* Upgrade deploy docs to Netlify GitHub action. PR [#57](https://github.com/tiangolo/typer/pull/57).
* Add support for Mermaid JS for visualizations. PR [#56](https://github.com/tiangolo/typer/pull/56).
2020-02-15 13:39:47 +01:00
* Update CI to run docs deployment in GitHub actions. PR [#50](https://github.com/tiangolo/typer/pull/50).
2020-01-18 20:41:36 +01:00
* Update format for internal links. PR [#38](https://github.com/tiangolo/typer/pull/38).
2020-01-17 16:43:39 +01:00
* Tweak external links' format. PR [#36](https://github.com/tiangolo/typer/pull/36).
2020-01-05 22:41:59 +01:00
## 0.0.8
2020-01-05 22:39:23 +01:00
* Update docs and add latest changes to MkDocs/website. PR [#33](https://github.com/tiangolo/typer/pull/33).
* Add extra tests for edge cases that don't belong in docs' examples. PR [#32](https://github.com/tiangolo/typer/pull/32).
* Add docs for CLI Parameters with [Multiple Values](https://typer.tiangolo.com/tutorial/multiple-values/). Includes tests for all the examples and bug fixes. PR [#31](https://github.com/tiangolo/typer/pull/31).
* Add docs for extra *CLI parameter* types: [CLI Parameter Types: Number](https://typer.tiangolo.com/tutorial/parameter-types/number/) and [CLI Parameter Types: Boolean CLI Options](https://typer.tiangolo.com/tutorial/parameter-types/bool/). PR [#30](https://github.com/tiangolo/typer/pull/30).
* Extend docs for Commands, add [Commands: Typer Callback](https://typer.tiangolo.com/tutorial/commands/callback/) and [Commands: One or Multiple](https://typer.tiangolo.com/tutorial/commands/one-or-multiple/). This includes tests for all the examples and bug fixes. PR [#29](https://github.com/tiangolo/typer/pull/29).
* Add docs for [SubCommands - Command Groups](https://typer.tiangolo.com/tutorial/subcommands/). This includes tests for all the examples and bug fixes. PR [#28](https://github.com/tiangolo/typer/pull/28).
2020-01-02 19:33:37 +01:00
* Remove unneeded code for argument handling. PR [#26](https://github.com/tiangolo/typer/pull/26).
2020-01-02 19:23:19 +01:00
* Add docs for [Launching Applications](https://typer.tiangolo.com/tutorial/launch/). PR [#25](https://github.com/tiangolo/typer/pull/25).
2020-01-02 18:53:21 +01:00
* Add docs for getting the [CLI Application Directory](https://typer.tiangolo.com/tutorial/app-dir/). PR [#24](https://github.com/tiangolo/typer/pull/24).
2020-01-02 18:41:53 +01:00
* Add docs for [Progress Bars](https://typer.tiangolo.com/tutorial/progressbar/). PR [#23](https://github.com/tiangolo/typer/pull/23).
2020-01-02 17:05:49 +01:00
* Add docs for [Asking with Interactive Prompts](). PR [#22](https://github.com/tiangolo/typer/pull/22).
2020-01-02 16:35:37 +01:00
* Update docs for path *CLI option*. PR [#21](https://github.com/tiangolo/typer/pull/21).
2020-01-02 16:13:56 +01:00
* Add colors module and docs for [Printing and Colors](https://typer.tiangolo.com/tutorial/printing/) and for [Terminating](https://typer.tiangolo.com/tutorial/terminating/), including tests. PR [#20](https://github.com/tiangolo/typer/pull/20).
2020-01-02 12:59:13 +01:00
* Refactor docs to make each individual page/section "bite-sized" / small. Add docs for [CLI option names](https://typer.tiangolo.com/tutorial/options/name/). Update `typer.Argument()` to remove invalid positional `param_decls`. PR [#19](https://github.com/tiangolo/typer/pull/19).
2019-12-31 22:30:45 +01:00
## 0.0.7
2019-12-31 22:27:13 +01:00
* Add docs for [*CLI parameter* types](https://typer.tiangolo.com/tutorial/parameter-types/). Includes tests and file classes refactor. PR [#17](https://github.com/tiangolo/typer/pull/17).
2019-12-31 11:33:57 +01:00
* Add tests for completion. PR [#15](https://github.com/tiangolo/typer/pull/15) and [#16](https://github.com/tiangolo/typer/pull/16).
2019-12-30 14:41:53 +01:00
## 0.0.6
2019-12-30 14:41:03 +01:00
* Add docs for [Commands](https://typer.tiangolo.com/tutorial/commands/). Includes a bug fix for handling default values set in `typer.Typer()` parameters. PR [#14](https://github.com/tiangolo/typer/pull/14).
2019-12-29 17:15:24 +01:00
* Add docs for [CLI Arguments](https://typer.tiangolo.com/tutorial/arguments/). PR [#13](https://github.com/tiangolo/typer/pull/13).
2019-12-29 12:53:51 +01:00
* Add docs for [CLI Options](https://typer.tiangolo.com/tutorial/options/). PR [#12](https://github.com/tiangolo/typer/pull/12).
2019-12-28 15:28:11 +01:00
## 0.0.5
2019-12-28 15:23:59 +01:00
* Clean exports from Typer. Remove unneeded components from Click and add needed `Exit` exception. PR [#11](https://github.com/tiangolo/typer/pull/11).
* Fix and document extracting help from a function's docstring [First Steps: Document your CLI app](https://typer.tiangolo.com/tutorial/first-steps/#document-your-cli-app). PR [#10](https://github.com/tiangolo/typer/pull/10).
2019-12-28 14:21:29 +01:00
* Update references to `--install-completion` and `--show-completion` in docs. PR [#9](https://github.com/tiangolo/typer/pull/9).
2019-12-28 14:10:12 +01:00
* Fix testing utilities, add tests for First Steps examples. PR [#8](https://github.com/tiangolo/typer/pull/8).
2019-12-27 12:24:07 +01:00
* Add auto completion options by default when [click-completion](https://github.com/click-contrib/click-completion) is installed: `--install-completion` and `--show-completion`. PR [#7](https://github.com/tiangolo/typer/pull/7).
2019-12-27 00:14:58 +01:00
* Update Termynal to have fixed sizes, add "fast" button, and use it in [First Steps](https://typer.tiangolo.com/tutorial/first-steps/). PR [#6](https://github.com/tiangolo/typer/pull/6).
* Add custom automatic [Termynal](https://github.com/tiangolo/termynal) for docs. PR [#5](https://github.com/tiangolo/typer/pull/5).
2019-12-26 21:19:53 +01:00
2019-12-24 21:17:05 +01:00
## 0.0.4
2019-12-24 21:16:03 +01:00
* Update short descriptions and assets.
2019-12-24 20:42:31 +01:00
* Docs rewording and fix typos. PR [#1](https://github.com/tiangolo/typer/pull/1) by [@mariacamilagl](https://github.com/mariacamilagl).
2019-12-24 18:06:28 +01:00
## 0.0.3
2019-12-24 18:05:55 +01:00
* Fix group creation without name.
2019-12-24 17:26:35 +01:00
## 0.0.2
2019-12-24 13:31:59 +01:00
* Add initial version of code, docs, etc.
## 0.0.1
* First commit. Publish to PyPI to reserve package name.