Commit graph

240 commits

Author SHA1 Message Date
Kian-Meng Ang
cf7ffa4792
✏ Fix typo in docs/tutorial/terminating.md (#382)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2022-05-12 19:13:47 +00:00
github-actions
0fcc8f438b 📝 Update release notes 2022-05-12 19:13:33 +00:00
Ryan Streur
d5223d6de4
✏ Fix syntax typo in docs/tutorial/package.md (#333)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2022-05-12 19:13:14 +00:00
Michael Rios
808a15f942
✏ Fix typo, duplicated word in docs/tutorial/options/required.md. (#316)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2022-05-12 19:12:34 +00:00
github-actions
dc26b21064 📝 Update release notes 2022-05-12 19:08:00 +00:00
Roald Storm
a55c9b086b
✏ Fix minor typo in index.md (#274)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2022-05-12 19:07:19 +00:00
github-actions
78a7b90c31 📝 Update release notes 2022-05-12 19:06:24 +00:00
Nicoló Lino
2fc51f2c33
✏ Fix double "and" typo in first-steps tutorial (#225)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2022-05-12 19:05:04 +00:00
github-actions
eb67474541 📝 Update release notes 2022-05-12 19:03:04 +00:00
Diego Piloni
e61aa15596
🎨 Fix format in docs explaining datetime parameter type (#220)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2022-05-12 19:02:22 +00:00
github-actions
c3b1c86626 📝 Update release notes 2022-05-12 17:53:48 +00:00
github-actions
85c0c52961 📝 Update release notes 2022-05-12 17:12:44 +00:00
github-actions
c58948cb1f 📝 Update release notes 2022-05-12 01:11:19 +00:00
github-actions
09600794be 📝 Update release notes 2022-05-12 01:00:33 +00:00
Sebastián Ramírez
a1ee41186f
🔧 Add pre-commit config and formatting (#392) 2022-05-11 19:59:56 -05:00
github-actions
27bd56dce1 📝 Update release notes 2022-05-11 23:14:18 +00:00
github-actions
239d6dea87 📝 Update release notes 2022-04-16 08:21:38 +00:00
Sebastián Ramírez
d5bc56177e 🔖 Release version 0.4.1 2022-03-30 14:15:11 -05:00
Sebastián Ramírez
3b390ea538 📝 Update release notes 2022-03-30 14:14:38 -05:00
github-actions
4bf219b3c9 📝 Update release notes 2022-03-30 19:12:12 +00:00
github-actions
6d8e954664 📝 Update release notes 2022-03-05 19:04:50 +00:00
Sebastián Ramírez
51646dfee0
📝 Add Jina's QA Bot to the docs to help people that want to ask quick questions (#368)
Co-authored-by: yanlong.wang <yanlong.wang@naiver.org>
Co-authored-by: Han Xiao <han.xiao@jina.ai>
2022-03-05 20:04:13 +01:00
github-actions
06b6a3e055 📝 Update release notes 2022-02-13 17:08:15 +00:00
github-actions
bfb7afb6eb 📝 Update release notes 2022-02-13 17:02:27 +00:00
github-actions
ac0e1bb43d 📝 Update release notes 2022-02-13 16:36:27 +00:00
github-actions
a1520dcda6 📝 Update release notes 2021-08-30 09:02:44 +00:00
Sebastián Ramírez
aab42c985d 📝 Update release notes
because it was actually a LOT of work to *not* break changes
2021-08-30 10:54:58 +02:00
Sebastián Ramírez
780f90f5bd 🔖 Release version 0.4.0 2021-08-30 10:53:49 +02:00
github-actions
722c5fc860 📝 Update release notes 2021-08-30 08:51:18 +00:00
github-actions
0f5cfc4103 📝 Update release notes 2021-08-30 08:50:51 +00:00
Sebastián Ramírez
45179f0fe8 📝 Update release notes 2021-08-30 10:46:55 +02:00
github-actions
9f5fb9e321 📝 Update release notes 2021-08-30 08:31:19 +00:00
github-actions
28f9b57a46 📝 Update release notes 2021-08-30 08:30:21 +00:00
github-actions
c866428caa 📝 Update release notes 2021-08-30 08:29:32 +00:00
github-actions
c397a5497a 📝 Update release notes 2021-08-30 08:28:46 +00:00
github-actions
0d0fc99386 📝 Update release notes 2021-08-30 08:26:51 +00:00
Sebastián Ramírez
75559ff615 📝 Update release notes 2021-08-30 10:25:37 +02:00
Sebastián Ramírez
e3e01cea2c
🔧 Add sponsors docs and badge (#319) 2021-08-30 10:05:59 +02:00
Sebastián Ramírez
b97298181b
Add support for Click 8 while keeping compatibility with Click 7 (#317) 2021-08-30 09:57:12 +02:00
Sebastián Ramírez
c3a4c72a4f 🔖 Release version 0.3.2 2020-08-16 16:52:47 +02:00
Sebastián Ramírez
35eefeb411 📝 Update release notes 2020-08-16 16:41:10 +02:00
Sebastián Ramírez
4312ead23a 📝 Update release notes 2020-08-16 14:21:17 +02:00
JAYATI SHRIVASTAVA
39a6552808
📝 Update docs with the new --help argument (#135)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-08-16 14:19:40 +02:00
Sebastián Ramírez
ab5da80365 📝 Update release notes 2020-08-16 14:04:50 +02:00
Rupsi Kaushik
32436f0b1a
📝 Add Optional to docs for CLI Arguments and Options with a None default (#131)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-08-16 14:01:19 +02:00
Sebastián Ramírez
c2235d1bbf 📝 Update release notes 2020-08-16 13:34:01 +02:00
Cathal O'Callaghan
26ccd5f6b7
📝 Add date string formats to docs (#122) 2020-08-16 13:27:44 +02:00
Sebastián Ramírez
c4e3e460db 📝 Update release notes 2020-07-19 14:38:34 +02:00
Sebastián Ramírez
cef7fee73b 📝 Update release notes 2020-07-19 13:28:37 +02:00
Sebastián Ramírez
f67a47e508
💄 Update badges and remove Travis (#145) 2020-07-19 13:27:40 +02:00
Sebastián Ramírez
c56789e8eb 🔖 Release version 0.3.1 2020-07-19 13:07:28 +02:00
Sebastián Ramírez
6f5808f1f4 📝 Update release notes 2020-07-19 13:05:37 +02:00
Sebastián Ramírez
46f30dfaa8 📝 Update release notes 2020-07-09 23:47:55 +02:00
Sebastián Ramírez
4c345568a4 📝 Update release notes 2020-07-09 23:23:19 +02:00
Sebastián Ramírez
012ebbd6af 📝 Update release notes 2020-07-09 22:10:45 +02:00
Sebastián Ramírez
89ddc35372
⬆ Upgrade Isort to version 5.x.x (#137)
* 🚚 Move docs src files to root docs_src

* 🚚 Update example includes from root docs_src

* 🚚 Import docs src examples for tests from docs_src

* ⬆️ Upgrade isort and configs

* 🎨 Update format in testing

* 🔧 Update configs with root docs_src

* 🔥 Remove obsolete/unecessary section in contributing guide

* 🎨 Re-format multi-file example

*  Revert format for multi-file examples

* 🔧 Add isort skips for multi-file examples
2020-07-09 22:09:53 +02:00
Sebastián Ramírez
f5682d3110 🔖 Release version 0.3.0 2020-06-24 21:21:08 +02:00
Sebastián Ramírez
6a6dfbb08c 📝 Update release notes 2020-06-24 21:20:15 +02:00
Sebastián Ramírez
15380ddc07
Add support for help for CLI arguments (#123)
*  Implement custom TyperCommand and TyperArgument

to support help in CLI Arguments

*  Update data models to store help for CLI Arguments

*  Add help to typer.Argument()

*  Use new TyperCommand and TyperArgument classes by default

to support CLI Arguments with help

*  Update failing test

*  Make showing default values default to true and support arguments hidden from help text

*  Add docs for CLI arguments with defaults, help, and new features

* 📝 Update CLI options with new show_default=True by default

* 📝 Add example of CLI arguments with tuples

* 📝 Update docs with new generated help text for CLI arguments

* 📝 Use Optional for None example in micro-intro to types

*  Add tests for new CLI argument features from docs examples

*  Update tests with new generated help text for CLI arguments

*  Add tests for CLI arguments with tuple defaults

* 🔧 Update MkDocs with new sections

*  make show_envvar default to True

*  Add docs for envvar in CLI arguments

*  Add tests for CLI arguments with env vars from docs

* 🎨 Add format to CLI usage examples in docs

* 🔧 Add section about CLI arguments with env vars to MkDocs

* 📝 Fix link in docs with new structure

* 🎨 Fix format in first-steps
2020-06-24 21:05:21 +02:00
Sebastián Ramírez
338d05fdc7 📝 Update release notes 2020-06-23 14:54:34 +02:00
Sebastián Ramírez
fe60816e56
📝 Add docs for __main__.py (#121) 2020-06-23 14:52:19 +02:00
Sebastián Ramírez
9b9c4e5239 📝 Update release notes 2020-06-23 14:42:03 +02:00
Sebastián Ramírez
f6304f16fd 📝 Update release notes 2020-06-22 19:54:41 +02:00
Evan E. Baird
2bc3b9a204
✏ Fix typos in main page/README (#103)
* 👌 IMPROVE: Correcting typos

* 📝 Replicate fixes to README to docs/index.md

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-22 19:53:17 +02:00
Sebastián Ramírez
6be74b88e1 📝 Update release notes 2020-06-22 19:27:25 +02:00
Evan E. Baird
877cf18296
✏ Fix typo in docs (#98)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-22 19:19:46 +02:00
Sebastián Ramírez
57343e1402 🎨 Update format in docs 2020-06-22 19:05:58 +02:00
Sebastián Ramírez
bf19519ece 📝 Update release notes 2020-06-22 19:04:28 +02:00
Evan E. Baird
a3316193be
✏ Fix typos and rewording in docs (#97) 2020-06-22 18:56:53 +02:00
Sebastián Ramírez
45fb7c4739 📝 Update release notes 2020-06-06 14:30:16 +02:00
Sebastián Ramírez
a44c9da821 📝 Sync Typer CLI docs, Coverage badge 2020-04-26 16:27:58 +02:00
Sebastián Ramírez
611c507bf5 🔖 Release version 0.2.1 2020-04-26 15:48:56 +02:00
Sebastián Ramírez
860d5fc02b 📝 Update release notes 2020-04-26 15:43:19 +02:00
Sebastián Ramírez
deda63ab16 🔖 Release version 0.2.0 2020-04-26 12:50:20 +02:00
Sebastián Ramírez
0c473b0182 📝 Update release notes 2020-04-26 12:20:16 +02:00
Sebastián Ramírez
9cc3ebeab3 📝 Update release notes 2020-04-18 12:47:51 +02:00
Sebastián Ramírez
372efa998b
📝 Add emphasis note about using typer.echo instead of print (#89) 2020-04-18 12:46:55 +02:00
Sebastián Ramírez
d7d05e69fc 📝 Update release notes 2020-04-18 12:39:48 +02:00
Sebastián Ramírez
ce9e08d8e7
Upgrade Material-Mkdocs (#90)
*  Upgrade Material-Mkdocs

* 🐛 Fix Mkdocs config bug

*  Upgrade Mkdocs-material configs
2020-04-18 12:38:12 +02:00
Sebastián Ramírez
cc53e9437c 🔖 Release version 0.1.1 2020-03-29 15:44:09 +02:00
Sebastián Ramírez
708b5fc632 📝 Update release notes 2020-03-29 15:41:53 +02:00
Sebastián Ramírez
e7d2d33573 📝 Update release notes 2020-03-29 14:30:04 +02:00
Sebastián Ramírez
d90344dab0
🐛 Fix Bash completion install to .bashrc (#81)
* 🐛 Fix Bash completion setup to .bashrc

* 📝 Update docs and script for Windows development environment
2020-03-29 14:26:54 +02:00
Sebastián Ramírez
b28f920a81 📝 Update release notes 2020-03-27 18:16:09 +01:00
Sebastián Ramírez
b7aa9e48a3
🎨 Update testing coverage badge (#78) 2020-03-27 18:15:34 +01:00
Sebastián Ramírez
18a9719a24 📝 Update release notes 2020-03-19 14:55:15 +01:00
Sebastián Ramírez
46984fcb17 🔖 Release version 0.1.0 2020-03-19 14:50:02 +01:00
Sebastián Ramírez
fa3a9ea64f 📝 Update release notes 2020-03-19 14:45:16 +01:00
Sebastián Ramírez
a89fc4ebb7
white_check_mark: Add coverage instructions to tests (#72)
*  Add coverage instructions to tests

* 📝 Update docs note about coverage in features

* 🎨 Fix format

* 🎨 Update testing docs format
2020-03-19 14:44:43 +01:00
Sebastián Ramírez
0830c023b9
📝 Add docs section, build a package from scratch (#71)
* 📝 Add docs section, build a package from scratch

* 📝 Update Package docs

* ✏️ Fix internal links
2020-03-19 13:42:23 +01:00
Sebastián Ramírez
150baa2fe7 📝 Update release notes 2020-03-19 10:31:07 +01:00
Sebastián Ramírez
48698ff2ad
📝 Add docs for using Click with Typer (#70)
* 📝 Add docs for using Click with Typer

*  Add tests for integrating Click and Typer
2020-03-19 10:30:42 +01:00
Sebastián Ramírez
9e3553adab 📝 Update release notes 2020-03-19 08:48:35 +01:00
Valentin Calomme
78d8367c75
✏️ fix typo in progressbar/tutorial004.py (#63)
In the tutorial, the length of the progress bar is set to 1000 and the update was mistakenly set to 2500. The update should be 1/4 of the length given that the loop runs for 4 iterations. This commit sets the update amount to 250 which better showcases the feature.
2020-03-19 07:45:45 +01:00
Sebastián Ramírez
5a6379ffc6
Add docs for testing, password, version, context. Extra tests, include callback and autocompletion PR (#68)
*  Implement custom handling for callbacks with types

*  Implement type-based handling for completion functions

*  Add examples for custom completion

* 📝 Add docs for custom autocompletion

*  Add tests for autocompletion

*  Document using the context

*  Add tests for using the context

*  Add tests init for context

* 🔧 Update Mypy config

*  Add extra tests for completion

* ✏️ Fix format, typos, and minor texts

*  Update docs for printing, include stdout, stderr, and stdin

* ✏️ Add references to FastAPI, fix typos

* ✏️ Fix typo in Typer CLI

* 📝 Update docs for version

* 📝 Update docs for callbacks

* 📝 Update references to stdout/stderr in autocompletion

* 📝 Add docs for password in CLI option

* 📝 Add docs and tests for Testing

* 📝 Add new sections to docs

* 🎨 Fix formatting
2020-03-18 21:17:47 +01:00
Sebastián Ramírez
eec98bafe6 🔖 Release version 0.0.11 2020-03-16 13:24:10 +01:00
Sebastián Ramírez
6d2cff810c 📝 Update release notes 2020-03-16 13:23:10 +01:00
Sebastián Ramírez
1d3337a4da
Re-implement completion, fixes, add PowerShell support (#66)
*  Re-implement completion

*  Add tests for re-implemented completion

* 🎨 Move mypy config to file

* 🙈 Update .gitignore

*  Remove click-completion, add support for autodetection with shellingham

*  Fix test for PowerShell

* 🐛 Fix PowerShell permissions/test

* 🎨 Format test

* 🏁 Fix PowerShell script for Windows and PowerShell 5

* 📝 Update docs, internal implementation of completion
2020-03-16 13:21:58 +01:00
Sebastián Ramírez
d651b7dc77 📝 Update release notes 2020-03-12 10:47:07 +01:00
Sebastián Ramírez
12eef051c8
🐛 Fix docs format with hl_lines (#65) 2020-03-12 10:46:32 +01:00