summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* multilineCommands -> multiline_commandskotfu2018-04-292-2/+2
|
* Removed pyparsing from setup.py as a dependencyTodd Leonhardt2018-04-281-2/+1
| | | | | | Also: - updated README.md to correctly state 3rd-party dependencies - Updated docs/requirements.txt to no longer include pyparsing for ReadTheDocs build
* Remove POSIX_SHLEX and STRIP_QUOTES_FOR_NON_POSIXkotfu2018-04-251-10/+0
|
* Added some documentation related to the latest changes.Eric Lin2018-04-211-6/+4
|
* Merged ReadTheDocs build fix from masterTodd Leonhardt2018-04-181-1/+0
|\
| * Trying to fix Sphnix build on ReadTheDocsTodd Leonhardt2018-04-181-3/+0
| | | | | | | | | | | | | | | | We changed the cmd2 project to now build using Python 3. So we need to tweak what modules get installed for building the docs. The following modules were backports for Python 2 and needed to be removed: - subprocess32 - enum34
* | Tweaked AutoCompleter.ACArgumentParser's constructor to pass through ↵Eric Lin2018-04-181-2/+1
|/ | | | constructor parameters in a more concise/general way. May also resolve the weird Mac issue on Python 3.6
* Fix documentation which referred to a single/one source fileTodd Leonhardt2018-04-171-2/+2
|
* Finished removing all dependencies on the six moduleTodd Leonhardt2018-04-152-2/+0
|
* Removed reference to Python 2 and 2.7 in some sections of the documentationTodd Leonhardt2018-04-153-22/+6
|
* Removed unit test dependency on mockTodd Leonhardt2018-04-151-0/+1
| | | | | mock was a backport of Python's built in unittest.mock and was required for Python 3.2 or earlier - Since we now support Python 3.4+ moving forward we no longer need to make use of the 3rd party mock module
* Merged master into delete_optparse branchTodd Leonhardt2018-04-151-2/+2
|\ | | | | | | | | Also: - Bumped version to 0.9.0
| * Preparation for 0.8.5 releaseTodd Leonhardt2018-04-131-1/+1
| | | | | | | | | | - Bumped version to 0.8.5 - Added details to CHANGELOG.md regarding recent changes
* | Merge branch 'master' into delete_optparseTodd Leonhardt2018-04-111-0/+132
|\ \ | |/ | | | | | | # Conflicts: # cmd2.py
| * Added a with_category decorator that can be used to tag a command category.Eric Lin2018-04-111-0/+132
| | | | | | | | | | | | | | | | | | Changed the detection of with_argparse decorated commands to be less hacky/brittle. Now it tags the function with help_summary. Fixed issue with handling commands that provide a custom help_ function. We can now redirect the output to a string to be formatted with the other commands. Added some documentation explaining the new help categories. Updated unit tests.
| * Preparing for 0.8.4 release0.8.4Kevin Van Brunt2018-04-101-1/+1
| |
* | Updated version to 0.8.5Todd Leonhardt2018-04-101-1/+1
| |
* | Deleted optparse code which had been previously deprecated in 0.8.0 releaseTodd Leonhardt2018-04-094-51/+4
|/ | | | | Also: - Bumped version to 0.8.4
* Updated version number of release0.8.3Kevin Van Brunt2018-04-091-1/+1
|
* Add conditional dependency on enum34 for Python 2.7Todd Leonhardt2018-03-281-0/+2
|
* Addressed code review commentsKevin Van Brunt2018-03-271-0/+5
|
* Updated documentationKevin Van Brunt2018-03-251-3/+2
|
* Added link to video of Florida Pycon 2017 presentation on cmd2Todd Leonhardt2018-03-231-2/+1
| | | | Link added to both README and Resources section of Sphinx docs.
* Added back in preference for gnureadline if it is presentTodd Leonhardt2018-03-212-5/+33
| | | | | | Now that the crash bug in the gnureadline Python module which statically links against a compatible version of GNU Readline has been fixed for macOS, we added back in the top-level import boilerplate to prefer it if it is available. Also updated some documentation in relation to getting readline installed for macOS.
* Fixed small typos and changed example code class nameMark Lalor2018-03-171-4/+4
|
* Added a tiny bit of documentationTodd Leonhardt2018-03-172-2/+15
|
* Documented cmd_with_subs_completer functionKevin Van Brunt2018-03-161-0/+6
|
* Removed commaKevin Van Brunt2018-03-161-1/+1
|
* Added documentaionKevin Van Brunt2018-03-162-8/+24
|
* Added table_display.pyTodd Leonhardt2018-03-141-1/+1
| | | | | | | | Added example showing how to display tabular data in a cmd2 application. Also: - Updated CHANGELOG with data on all PRs since last release - Bumped version to 0.8.2 in preparation for next release
* Added documentation for quit_on_sigintMark Lalor2018-03-141-0/+15
|
* Fix typos in freefeatures.rstMark Lalor2018-03-111-2/+2
| | | Changed "built-in" instead of "build-in" and fixed accidental capitalization of a letter.
* Refactored the Windows vs macOS/Linux conditional in ppaged()Todd Leonhardt2018-03-071-3/+5
| | | | | | | Aslo: - Added some documentation for ppaged() - Updated CHANGELOG - Added line about ppaged() in README
* Removed support for case-insensitive command parsingTodd Leonhardt2018-03-021-10/+0
|
* Removed abbrev attributeKevin Van Brunt2018-03-022-19/+1
|
* Changed pipeing to pipingTodd Leonhardt2018-02-271-1/+1
|
* Improved the documentation regarding poutput, particularly with transcriptsTodd Leonhardt2018-02-242-0/+11
| | | | | | The documentation didn't make it very clear that the poutput() method should be used for generating output from cmd2 commands. This PR attempts to fix that. This closes #275.
* First past at unit test for persistent history featureTodd Leonhardt2018-02-091-0/+1
| | | | | | Added pexpect to modules required for running unit tests. This opens the door for carefully crafted complex unit tests to verify intricate behavior. Tests like this are somewhat painful to write and slow to execute. However, they can enable testing complicated interactive behavior that we otherwise probably would not be able to test.
* Added optional persistent readline history featureTodd Leonhardt2018-02-082-7/+10
| | | | | | | | | | | | - Including an example and info in the Sphinx docs Also: - Created CHANGELOG entry for 0.8.1 release - Added info to README about new sub-menu feature - Bumped version to 0.8.1 TODO: - Added a unit test for the persistent readline history feature
* Improved argument processing docsTodd Leonhardt2018-02-011-14/+38
| | | | | | | | Improved the documentation related to how to use the argparse decorators. Also: - Fixed a comment in cmd2.py which referred to the old decorator before the rename - Fixed README.md which had the old decorator name in it prior to the rename
* Updated documentation in regards to automated transcript generationTodd Leonhardt2018-01-311-6/+21
|
* Added documentation about Python 3.4 and earlier now having an additional ↵Todd Leonhardt2018-01-221-0/+5
| | | | dependency on contextlib2
* Renamed @with_argument_parser decorator to @with_argparserTodd Leonhardt2018-01-211-9/+9
| | | | | Also: - Reanamed foo and bar subcommand methods to base_foo and base_bar
* Added unit tests for newly-overridden complete() methodTodd Leonhardt2018-01-201-2/+11
| | | | Also added a section on Sub-commands to the documentation.
* Added links to docs and examples to CHANGELOG.mdTodd Leonhardt2018-01-201-2/+2
| | | | Also bumped version to 0.8.0.
* Simplified a few argparse examples and fixed some incorrect documentationTodd Leonhardt2018-01-171-10/+12
| | | | | | I eliminated a few "narg=1" configurations so that a single str value is returned instead of a List[str]. I also reworded some documentation which was no longer correct after the last commit which made "history command" have the same help text as "command -h" when using one of the two argparse decorators.
* Cleanup of documentation and examplesTodd Leonhardt2018-01-172-8/+4
| | | | Removed usage of and reference to attributes and commands which have now been removed.
* Revised some of the Sphinx documentation which referenced the deprecated ↵Todd Leonhardt2018-01-152-64/+10
| | | | @options optparse-based decorator
* Changed @with_argument_parser to only pass single argument to commandsTodd Leonhardt2018-01-151-10/+33
| | | | Also added another @with_argparser_and_list decorator that uses argparse.parse_known_args to pass two arguments to a command: both the argparse output and a list of unknown/unmatched args.
* remove use_argument_list attributekotfu2018-01-141-33/+1
|