You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-25Lines changed: 28 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,30 +39,30 @@ The price we pay for beautifully colored displays is complexity required to aggr
39
39
The `cmd2` framework provides a great mixture of both worlds. Application designers can easily create complex applications and rely on the cmd2 library to offer effortless user facing help and extensive tab completion.
40
40
When users become comfortable with functionality, cmd2 turns into a feature rich library enabling a smooth transition to full automation. If designed with enough forethought, a well implemented cmd2 application can serve as a boutique workflow tool. `cmd2` pulls off this flexibility based on two pillars of philosophy:
41
41
42
-
- Tab Completion
43
-
- Automation Transition
42
+
-Tab Completion
43
+
-Automation Transition
44
44
45
45
## Philosophy
46
46
47
47
<ahref="https://imgflip.com/i/63h03x"><imgsrc="https://i.imgflip.com/63h03x.jpg"title="made at imgflip.com"width="70%"height="%70"/></a>
48
48
49
49
Deep extensive tab completion and help text generation based on the argparse library create the first pillar of 'ease of command discovery'. The following is a list of features in this category.
50
50
51
-
- Great tab completion of commands, subcommands, file system paths, and shell commands.
52
-
- Custom tab completion for user designed commands via simple function overloading.
53
-
- Tab completion from `persistent_history_file` sources added with very little friction.
54
-
- Automatic tab completion of `argparse` flags and optional arguments.
55
-
- Path completion easily enabled.
56
-
- When all else fails, custom tab completion based on `choices_provider` can fill any gaps.
51
+
-Great tab completion of commands, subcommands, file system paths, and shell commands.
52
+
-Custom tab completion for user designed commands via simple function overloading.
53
+
-Tab completion from `persistent_history_file` sources added with very little friction.
54
+
-Automatic tab completion of `argparse` flags and optional arguments.
55
+
-Path completion easily enabled.
56
+
-When all else fails, custom tab completion based on `choices_provider` can fill any gaps.
57
57
58
58
<ahref="https://imgflip.com/i/66t0y0"><imgsrc="https://i.imgflip.com/66t0y0.jpg"title="made at imgflip.com"width="70%"height="70%"/></a>
59
59
60
60
cmd2 creates the second pillar of 'ease of transition to automation' through alias/macro creation, command line argument parsing and execution of cmd2 scripting.
61
61
62
-
- Flexible alias and macro creation for quick abstraction of commands.
63
-
- Text file scripting of your application with `run_script` (`@`) and `_relative_run_script` (`@@`)
64
-
- Powerful and flexible built-in Python scripting of your application using the `run_pyscript` command
65
-
- Transcripts for use with built-in regression can be automatically generated from `history -t` or `run_script -t`
62
+
-Flexible alias and macro creation for quick abstraction of commands.
63
+
-Text file scripting of your application with `run_script` (`@`) and `_relative_run_script` (`@@`)
64
+
-Powerful and flexible built-in Python scripting of your application using the `run_pyscript` command
65
+
-Transcripts for use with built-in regression can be automatically generated from `history -t` or `run_script -t`
66
66
67
67
## Installation
68
68
@@ -88,14 +88,17 @@ The best way to learn the cmd2 api is to delve into the example applications loc
- More complex examples that demonstrate more featuers about how to put together a complete application
99
102
100
103
## Hello World
101
104
@@ -122,11 +125,11 @@ if __name__ == '__main__':
122
125
123
126
If you think you've found a bug, please first read through the open [Issues](https://github.com/python-cmd2/cmd2/issues). If you're confident it's a new bug, go ahead and create a new GitHub issue. Be sure to include as much information as possible so we can reproduce the bug. At a minimum, please state the following:
124
127
125
-
-`cmd2` version
126
-
- Python version
127
-
- OS name and version
128
-
- What you did to cause the bug to occur
129
-
- Include any traceback or error message associated with the bug
128
+
-`cmd2` version
129
+
-Python version
130
+
-OS name and version
131
+
-What you did to cause the bug to occur
132
+
-Include any traceback or error message associated with the bug
0 commit comments