typer/docs/release-notes.md

186 lines
14 KiB
Markdown
Raw Normal View History

2021-08-30 10:25:37 +02:00
## Latest Changes
2019-12-24 13:31:59 +01:00
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:26:51 +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).
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.