Commit graph

22 commits

Author SHA1 Message Date
Sebastián Ramírez
f67a47e508
💄 Update badges and remove Travis (#145) 2020-07-19 13:27:40 +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
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
b7aa9e48a3
🎨 Update testing coverage badge (#78) 2020-03-27 18:15:34 +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
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
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
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
2af83b0be5 📝 Refactor docs with internal links 2020-01-18 19:35:49 +01:00
Sebastián Ramírez
fc902304b6 🎨 Tweak external link format 2020-01-17 16:27:17 +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
95c1f103b3 📝 Fix typos, update docs and descriptions 2019-12-28 22:35:47 +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
e91c5a4aaa 📝 Fix GitHub markdown formatting 2019-12-26 21:22:43 +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
bc931c1935 📝 Update sub-header, short description 2019-12-24 21:14:42 +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
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
b52fc16bba 🎨 Fix types and format 2019-12-24 17:16:58 +01:00
Sebastián Ramírez
c24269f4cd 📝 Add first version of docs 2019-12-24 13:31:59 +01:00