Commit graph

401 commits

Author SHA1 Message Date
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
6da736487d
Report coverage in XML (#146)
*  Report XML Coverate to support GitHub Actions

* 🙈 Add coverage report to .gitignore

*  Add custom testing .zshrc logic for coverage
2020-07-19 14:37:50 +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
0c8a139dce
👷 Add GitHub Actions, move from Travis (#144) 2020-07-19 13:04:40 +02:00
Sebastián Ramírez
46f30dfaa8 📝 Update release notes 2020-07-09 23:47:55 +02:00
Sebastián Ramírez
9e9e47b3b4
📌 Pin dependencies (#138) 2020-07-09 23:47:08 +02:00
Sebastián Ramírez
4c345568a4 📝 Update release notes 2020-07-09 23:23:19 +02:00
Sebastián Ramírez
76677cdc6d
Add Dependabot, try and see how it behaves with Flit (#136) 2020-07-09 23:22:37 +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
Teymour Aldridge
4ed37fe043
Support __main__.py, passing prog_name to callable (#120)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-23 13:29:45 +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
3c377b088d
🔧 Update issue-manager (#114) 2020-06-06 14:29:34 +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
a93e6b2f86
Add support for forward references (#93)
*  Add support for forward references

*  Add forward references test

* 🐛 Fix coverage in completion

* 🐛 Fix testing with Pytest and Pytest-sugar

* 📌 Pin Pytest
2020-04-26 15:42:13 +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
cf95aa3f48
Make installed completion lazy load (#92)
*  Re-implement completion install to lazy load

to support completion for programs under environments

*  Update tests for new lazy loaded completion

*  Update test after removing period from message
2020-04-26 12:16:38 +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
646c737329
🐛 Do not show an error on completion eval if the program is not installed (#83)
* 🐛 Fix Fish completion script

* 🐛 Do not show an error on completion eval if the program is not installed

*  Add stderr redirect to /dev/null for Fish too

*  Update completion tests
2020-03-29 15:39:49 +02:00
Sebastián Ramírez
e445bd1711
🐛 Fix Fish completion script (#82) 2020-03-29 15:08:04 +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