luisgulo/typer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
378 commits 9 branches 26 tags 4.5 MiB
Commit graph

240 commits

Author SHA1 Message Date
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
Sebastián Ramírez
67ecde536f 📝 Update release notes 2020-03-11 17:17:49 +01:00
Sebastián Ramírez
96731c43be
✨ Docs for Typer CLI (#64) 
* ✨ Add docs for Typer CLI

* 📝 Update references to Typer CLI in docs

* 🔧 Update tests to check files and linting before tests, to error out early

* 📝 Sync README.md with docs/index.md
 2020-03-11 17:16:49 +01:00
Sebastián Ramírez
87fe78c04d 📝 Update release notes 2020-03-11 12:15:24 +01:00
Sebastián Ramírez
a77057f5b0
📝 Add docs about alternatives and inspiration (#62) 2020-03-11 12:13:50 +01:00
Sebastián Ramírez
dd7241181e
📝 Add contributing guide (#61) 2020-03-11 09:43:04 +01:00
Sebastián Ramírez
51e272a2ce 🔖 Release version 0.0.10 2020-03-10 18:51:38 +01:00
Sebastián Ramírez
00c9e3763f 📝 Update release notes 2020-03-10 18:50:47 +01:00
Sebastián Ramírez
96b29e9639
✨ Add support for Click 7.1.1 (#60) 
* ⬆️ Upgrade required Click to 7.1.1 and pin it to patch versions

as a MINOR version broke compatibility, so I'll have to upgrade manually every time

* 📌 Fix pinning Click to MINOR version

* ✨ Upgrade code to be compatible with latest Click changes

* ✅ Update tests with new format for errors

* 📝 Update docs to keep them in sync with actual output
 2020-03-10 18:49:29 +01:00
Sebastián Ramírez
e8a30e5261 🔖 Release version 0.0.9 2020-03-08 19:12:31 +01:00
Sebastián Ramírez
c9dfefb2db 📝 Update release notes 2020-03-08 19:11:54 +01:00
Sebastián Ramírez
31f7a44a46 📝 Update release notes 2020-02-15 13:39:47 +01:00
Sebastián Ramírez
fdb5b50c61 📝 Update release notes 2020-01-18 20:41:36 +01:00
Sebastián Ramírez
2af83b0be5 📝 Refactor docs with internal links 2020-01-18 19:35:49 +01:00
Sebastián Ramírez
62fd577b3d 📝 Update release notes 2020-01-17 16:43:39 +01:00
Sebastián Ramírez
fc902304b6 🎨 Tweak external link format 2020-01-17 16:27:17 +01:00
Sebastián Ramírez
9009a8d40c 🔖 Release version 0.0.8 2020-01-05 22:41:59 +01:00
Sebastián Ramírez
730a034d3f 📝 Update release notes 2020-01-05 22:39:23 +01:00
Sebastián Ramírez
5e063d8446 📝 Update docs for First Steps 2020-01-05 22:23:55 +01:00
Sebastián Ramírez
fb8622b8bb 📝 Add docs and examples for CLI parameters with multiple values 2020-01-05 22:09:41 +01:00
Sebastián Ramírez
421468c04c 📝 Add/extend docs and examples for param types. bool, int. 2020-01-05 21:52:46 +01:00
Sebastián Ramírez
56bb2576c4 📝 Add docs for callbacks and one or multiple commands 2020-01-05 21:37:44 +01:00
Sebastián Ramírez
daeb3b7656 ✨ Add docs and examples for subcommands 2020-01-05 20:47:16 +01:00
Sebastián Ramírez
b36c75b5a7 ✨ Add SubCommands sections 2020-01-04 02:25:02 +01:00
Sebastián Ramírez
416aba4fe7 ♻️ Refactor subcommands to not require being a package 2020-01-04 02:23:46 +01:00
Sebastián Ramírez
7938d89d5e ✨ Add first version of subcommands tutorial 2020-01-04 01:51:44 +01:00
Sebastián Ramírez
d12d00e919 📝 Update release notes 2020-01-02 19:33:37 +01:00
Sebastián Ramírez
15d790a9ae 📝 Update release notes 2020-01-02 19:23:19 +01:00
Sebastián Ramírez
bc4709cc9d 📝 Add docs for launching applications 2020-01-02 19:09:36 +01:00
Sebastián Ramírez
b925ed2c21 📝 Update docs for app_dir using Path 2020-01-02 19:08:53 +01:00
Sebastián Ramírez
d1970dabe7 📝 Update release notes 2020-01-02 18:53:21 +01:00
Sebastián Ramírez
fb46cc056c 📝 Add docs for get_app_dir() 2020-01-02 18:42:36 +01:00
Sebastián Ramírez
db25071eba 📝 Update release notes 2020-01-02 18:41:53 +01:00
Sebastián Ramírez
d172d69189 📝 Update release notes 2020-01-02 18:40:23 +01:00
Sebastián Ramírez
4f26f45134 📝 Add docs for progressbar 2020-01-02 18:17:21 +01:00
Sebastián Ramírez
d056aac6bc 📝 Update release notes 2020-01-02 17:05:49 +01:00
Sebastián Ramírez
541ef46319 📝 Add docs for asking with a prompt 2020-01-02 16:59:09 +01:00
Sebastián Ramírez
63db8947de 📝 Update release notes 2020-01-02 16:35:37 +01:00
Sebastián Ramírez
ff8a1e4c27 📝 Update path docs 2020-01-02 16:28:35 +01:00
Sebastián Ramírez
5876605f30 📝 Update release notes 2020-01-02 16:13:56 +01:00
Sebastián Ramírez
aadca21c0b 📝 Add docs for printing and terminating 2020-01-02 15:22:10 +01:00
Sebastián Ramírez
2af53e676a 📝 Update release notes 2020-01-02 12:59:13 +01:00
Sebastián Ramírez
d8a5236c08 ♻️ Refactor docs structure and add CLI option names 2020-01-02 12:49:28 +01:00
Sebastián Ramírez
19a4f6e217 🔖 Release 0.0.7 2019-12-31 22:30:45 +01:00
Sebastián Ramírez
0c7510e56d 📝 Update release notes 2019-12-31 22:27:13 +01:00
Sebastián Ramírez
073a72469c 📝 Add docs for CLI parameter types 2019-12-31 22:14:18 +01:00
Sebastián Ramírez
355c223bcb 📝 Update release notes 2019-12-31 11:33:57 +01:00
Sebastián Ramírez
e9c5cd6061 🔖 Release version 0.0.6 2019-12-30 14:41:53 +01:00
Sebastián Ramírez
32f399a96b 📝 Release notes 2019-12-30 14:41:03 +01:00
Sebastián Ramírez
0ece3b9772 📝 Fix wording to avoid confusion between CLI program, command, subcommand 2019-12-30 14:24:33 +01:00
Sebastián Ramírez
b88351643d 📝 Add docs and examples for Commands 2019-12-30 14:23:31 +01:00
Sebastián Ramírez
57b3cc1397 📝 Update release notes 2019-12-29 17:15:24 +01:00
Sebastián Ramírez
ce1316ce8f 🎨 Tweak Termynal CSS and emojis 2019-12-29 17:09:19 +01:00
Sebastián Ramírez
f6b61af6ae 📝 Add docs for CLI Arguments 2019-12-29 17:08:31 +01:00
Sebastián Ramírez
518517865d 📝 Update release notes 2019-12-29 12:53:51 +01:00
Sebastián Ramírez
345446321e 📝 Add CLI Options docs and examples 2019-12-29 10:23:31 +01:00
Sebastián Ramírez
13e0c8e90b ✨ Add support for custom prompts in custom Termynal 2019-12-28 22:37:51 +01:00
Sebastián Ramírez
95c1f103b3 📝 Fix typos, update docs and descriptions 2019-12-28 22:35:47 +01:00
Sebastián Ramírez
5aa9bddb02 🔖 Release 0.0.5 2019-12-28 15:28:11 +01:00
Sebastián Ramírez
8c12f80ebf 📝 Update release notes 2019-12-28 15:23:59 +01:00
Sebastián Ramírez
7cef6e5b7d 📝 Update release notes 2019-12-28 14:56:14 +01:00
Sebastián Ramírez
cf75cada76 📝 Update First Steps to include how to document in a docstring 2019-12-28 14:24:54 +01:00
Sebastián Ramírez
a65088170a 📝 Update release notes 2019-12-28 14:21:29 +01:00
Sebastián Ramírez
c941db5427 📝 Update docs with references to --install-completion 
and use subcommand everywhere instead of sub-command for consistency with Click
 2019-12-28 14:12:47 +01:00
Sebastián Ramírez
f192d9d4af 📝 Update release notes 2019-12-28 14:10:12 +01:00
Sebastián Ramírez
39e034e3f2 📝 Update release notes 2019-12-27 12:24:07 +01:00
Sebastián Ramírez
ecd724a6b7 📝 Update release notes 2019-12-27 00:14:58 +01:00
Sebastián Ramírez
941e86dbe5 🐛 Make Tutorial intro be the index, to have a tutorial root 2019-12-27 00:04:19 +01:00
Sebastián Ramírez
bed4e2b0e9 ✨ Update Termynal modifications, update first steps to use it 
Make Termynal have fixed sizes, add "fast" button, use it in first steps
 2019-12-27 00:02:53 +01:00
Sebastián Ramírez
e91c5a4aaa 📝 Fix GitHub markdown formatting 2019-12-26 21:22:43 +01:00
Sebastián Ramírez
0842c83c36 📝 Update release notes 2019-12-26 21:19:53 +01:00
Sebastián Ramírez
e3327b088b ✨ Add custom termynal handling for docs, with fenced code 2019-12-26 21:04:38 +01:00
Sebastián Ramírez
7fc3d1224a 🔖 Release version 0.0.4 2019-12-24 21:17:05 +01:00
Sebastián Ramírez
95098f1a58 📝 Update release notes 2019-12-24 21:16:03 +01:00
Sebastián Ramírez
0150d8c50b 🍱 Add GitHub social preview images 2019-12-24 21:15:16 +01:00
Sebastián Ramírez
bc931c1935 📝 Update sub-header, short description 2019-12-24 21:14:42 +01:00
Sebastián Ramírez
4acd87c078 📝 Update release notes 2019-12-24 20:42:31 +01:00
Sebastián Ramírez
7b115c305a
📝 Rewording in docs and fix typos 2019-12-24 20:40:59 +01:00
Camila Gutierrez
d985d5bcbf
Update docs/index.md 
Co-Authored-By: Sebastián Ramírez <tiangolo@gmail.com>
 2019-12-24 20:37:12 +01:00
Maria Camila Gutierrez
19e86b85c5 full doc review and fixing typos 2019-12-24 20:15:16 +01:00
Sebastián Ramírez
bfcc1909b0 🔖 Release version 0.0.3 2019-12-24 18:06:28 +01:00
Sebastián Ramírez
f75608964e 📝 Update release notes 2019-12-24 18:05:55 +01:00
Maria Camila Gutierrez
071740fbe8 improve wording and fix typos 2019-12-24 17:51:02 +01:00
Sebastián Ramírez
4792de37f6 🐛 Fix GitHub image 2019-12-24 17:34:55 +01:00
Sebastián Ramírez
86c82b1eea 🔖 Release version 0.0.2 2019-12-24 17:26:35 +01:00
Sebastián Ramírez
20b62537fb 📝 Fix Twitter links 2019-12-24 17:23:24 +01:00
Sebastián Ramírez
b52fc16bba 🎨 Fix types and format 2019-12-24 17:16:58 +01:00
Sebastián Ramírez
02a63e73b2 📝 Add docs for first steps 2019-12-24 13:32:50 +01:00
Sebastián Ramírez
c24269f4cd 📝 Add first version of docs 2019-12-24 13:31:59 +01:00
Sebastián Ramírez
64d1a5fd9b 🍱 Add completion example images 2019-12-24 13:31:12 +01:00
Sebastián Ramírez
e6f6d678f0 🍱 Add logos 2019-12-24 13:30:34 +01:00