diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2018-09-30 11:17:04 -0400 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2018-09-30 11:17:04 -0400 |
| commit | 81ad085cffc8f8af7fb7884bcc5db6fcede09df6 (patch) | |
| tree | a197a6c81767f10b62d6ac6acfd46e42357a8289 /README.md | |
| parent | 85a21ef39467dc24a6f6f8c4f3ac656f24d6ff90 (diff) | |
| parent | 61d5703cd3586b3460669a6260cf903c9863b240 (diff) | |
| download | cmd2-git-81ad085cffc8f8af7fb7884bcc5db6fcede09df6.tar.gz | |
Merged master into transcript_fixes branch and resolved conflicts
Diffstat (limited to 'README.md')
| -rwxr-xr-x | README.md | 18 |
1 files changed, 16 insertions, 2 deletions
@@ -14,8 +14,8 @@ applications. It provides a simple API which is an extension of Python's built- of cmd to make your life easier and eliminates much of the boilerplate code which would be necessary when using cmd. -[](https://github.com/python-cmd2/cmd2/blob/master/cmd2.png) - +Click on image below to watch a short video demonstrating the capabilities of cmd2: +[](https://youtu.be/DDU_JH6cFsA) Main Features ------------- @@ -31,6 +31,7 @@ Main Features - Multi-line commands - Special-character command shortcuts (beyond cmd's `?` and `!`) - Command aliasing similar to bash `alias` command +- Macros, which are similar to aliases, but can take arguments when called - Ability to load commands at startup from an initialization script - Settable environment parameters - Parsing commands with arguments using `argparse`, including support for sub-commands @@ -40,6 +41,7 @@ Main Features - Trivial to provide built-in help for all commands - Built-in regression testing framework for your applications (transcript-based testing) - Transcripts for use with built-in regression can be automatically generated from `history -t` +- Alerts that seamlessly print while user enters text at prompt Python 2.7 support is EOL ------------------------- @@ -259,3 +261,15 @@ timing: False Note how a regular expression `/(True|False)/` is used for output of the **show color** command since colored text is currently not available for cmd2 on Windows. Regular expressions can be used anywhere within a transcript file simply by enclosing them within forward slashes, `/`. + + +Found a bug? +------------ + +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: + +* ``cmd2`` version +* Python version +* OS name and version +* What you did to cause the bug to occur +* Include any traceback or error message associated with the bug |