summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* 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
|
* new @with_argument_list decoratorkotfu2018-01-121-0/+51
|
* @with_argument_parser now passes an arglist instead of a stringkotfu2018-01-121-5/+8
|
* Trivial doc change to get readthedocs to rebuildTodd Leonhardt2018-01-101-2/+3
|
* Write documentationkotfu2018-01-072-113/+147
|
* Merge branch 'master' of github.com:python-cmd2/cmd2 into argparsekotfu2018-01-073-3/+3
|\
| * Disabled Python 3.7-dev build in Travis CITodd Leonhardt2018-01-042-2/+2
| | | | | | | | | | | | | | There are a couple unit test failures with Python 3.7-dev that we will need to look into at some point, so I disabled that build for now. Updated all documentation to reflect that cmd2 is support on Python 2.7 and 3.4+. Official support for Python 3.3 has been abandoned due to no longer having support to test on that platform on Travis CI.
| * Updating version and changelog in preparation for minor bug fix realeaseTodd Leonhardt2018-01-041-1/+1
| |
* | Merge branch 'master' of https://github.com/python-cmd2/cmd2 into argparseJared Crapo2017-12-1124-735/+36
|\ \ | |/
| * Added a note to the installation instructions section of user manualTodd Leonhardt2017-11-151-0/+4
| |
| * Updated docs to make it more clear that you need to update shortcuts ↵Todd Leonhardt2017-11-092-6/+18
| | | | | | | | attribute before calling super class __init__
| * Removed broken link from docs0.7.8Todd Leonhardt2017-11-081-2/+1
| |
| * Fixed incorrect http link in the READMETodd Leonhardt2017-11-081-1/+1
| |
| * Added fix for changes in pyperclip project structure in the most recent versionTodd Leonhardt2017-11-0822-729/+15
| | | | | | | | | | | | | | | | | | Also included a number of minor maintenance updates: - Bumped version to 0.7.8 in preparation for upcoming release - Updated Readme.md to add link to slides from recent Florida PyCon talk about cmd2 - Updated documentation on integrating cmd2 with other event loops to use newer runcmds_plus_hooks() method instead of legacy onecmds_plus_hooks method which doesn't properly deal with load commands - Deleted old files which were used to prepare for a PyCon 2010 presentation - Updated ChangeLog regarding this bug fix
* | Plan and first working code for argparse decoratorJared Crapo2017-12-112-0/+142
|/
* Hopefully this fixes a bug which is causing autodoc to fail to add method ↵Todd Leonhardt2017-09-231-0/+1
| | | | | | | info on readthedocs I can build the docs locally and it works fine, but the autodoc part of Sphinx was failing on readthedocs - and it was failing due to pyperclip not being present
* Improved documentation for how a user can modify comment grammar/styleTodd Leonhardt2017-09-221-1/+2
| | | | | | | Also: - Added arg_print.py example to demonstrate this - Bumped version to 0.7.8a - Updated CHANGELOG
* Revise environment setting documentationkotfu2017-08-281-41/+33
|
* Updated CHANGELOG with some text regarding recent enhancements to transcript ↵Todd Leonhardt2017-08-221-1/+1
| | | | | | regexes Also bumped version from 0.7.7a to 0.7.7 in preparation for eventual next release.
* Clarify warnings about whitespaceJared Crapo2017-08-221-5/+6
|
* Documentation edits and revisionsJared Crapo2017-08-222-33/+28
|
* Revise and clean up documentationJared Crapo2017-08-213-31/+58
|
* regex implementation complete. Still a few bugs.Jared Crapo2017-08-211-0/+8
|
* Write documentation for revised transcription featureJared Crapo2017-08-213-24/+143
|
* Bump versions to 0.7.7aTodd Leonhardt2017-08-151-1/+1
| | | | This is to help distinguish latest code in GitHub from a version installed via pip from PyPI
* Replaced direct calls to self.stdout.write() with calls to self.poutput().Todd Leonhardt2017-08-081-0/+7
| | | | | | Modified implementation of poutput() to accept an optional "end" argument which can change the ending to something other than a newline or simply suppress adding a newline. Also added a try/except to catch BrokenPipeError exceptions which can occupoutputr if the subprocess output is being piped to closes before the command piping output to it is finished. Updated install docs to note that when using Python 2.7, the subprocess32 module should also be installed.