CLI apps with Typer - Python type annotations and shell completion

Transcript

1. CLI apps with type annotations and shell completion
2. Who am I? Sebastián Ramírez github.com/tiangolo linkedin.com/in/tiangolo twitter.com/tiangolo tiangolo.com Berlin, Germany Senior Staff Software Engineer at I created: ➕ External Consultant for other teams
3. About Typer • 8K+ GitHub stars • FastAPI's little sibling • Powered by Click @tiangolo
4. Command Line Interfaces (CLI) or Terminals @tiangolo • Text based • You send program and parameters • Computer goes beep boop • Maybe output • Examples of CLI apps: git, ssh, pip
5. Simple function with type annotations @tiangolo
6. Simple function with type annotations @tiangolo
7. Why type annotations - error checks @tiangolo
8. Why type annotations - completion @tiangolo
9. Simple function with type annotations - recap @tiangolo
10. Simple scripts with Typer @tiangolo
11. Simple scripts - required arguments @tiangolo
12. Simple scripts with Typer - main block @tiangolo
13. Simple scripts - required arguments missing @tiangolo
14. Simple scripts with --help @tiangolo
15. Simple scripts - options @tiangolo
16. Simple scripts - invalid data @tiangolo
17. Simple scripts - more help @tiangolo
18. Simple scripts - more help in the terminal @tiangolo
19. Simple scripts - help for parameters @tiangolo
20. Simple scripts - help for parameters in the terminal @tiangolo
21. A Typer app @tiangolo
22. A Typer app - app object @tiangolo
23. A Typer app - decorator @tiangolo
24. A Typer app - call the app @tiangolo
25. A Typer app - supergreet @tiangolo
26. Install completion @tiangolo ✨ Works for everything: • Zsh • Bash • Fish • PowerShell
27. Use completion @tiangolo
28. Use completion @tiangolo
29. Use completion @tiangolo
30. Use completion @tiangolo
31. Use completion @tiangolo
32. Completion @tiangolo 🧙 Works by default and can be used for: • Deeply nested commands • CLI Options and CLI Arguments • Custom data (e.g. remote, from an API) • etc.
33. Commands @tiangolo
34. Commands - hi @tiangolo
35. Commands - bye @tiangolo
36. Help with commands @tiangolo
37. Commands - hi again @tiangolo
38. Commands --help for hi @tiangolo
39. Command hi in terminal @tiangolo
40. Commands - bye @tiangolo
41. Commands --help for bye @tiangolo
42. More Typer features @tiangolo • 🥅 Boolean flags • ❓ Prompts • 🔒 Ask passwords • 🚀 Launch apps (e.g. a browser) • ✅ Easy testing • ✨ More…
43. Thank you! Sebastián Ramírez tiangolo.com typer.tiangolo.com github.com/tiangolo linkedin.com/in/tiangolo twitter.com/tiangolo