Added optional persistent readline history feature

- 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

1 files changed, 22 insertions, 0 deletions

diff --git a/examples/persistent_history.py b/examples/persistent_history.py
new file mode 100755
index 00000000..21a2cbf3
--- /dev/null
+++ b/examples/persistent_history.py
@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+# coding=utf-8
+"""This example demonstrates how to enable persistent readline history in your cmd2 application.
+
+This will allow end users of your cmd2-based application to use the arrow keys and Ctrl+r in a manner which persists
+across invocations of your cmd2 application.  This can make it much easier for them to use your application.
+"""
+import cmd2
+
+
+class Cmd2PersistentHistory(cmd2.Cmd):
+    """Basic example of how to enable persistent readline history within your cmd2 app."""
+    def __init__(self):
+        """"""
+        cmd2.Cmd.__init__(self, persistent_history_file='~/.persistent_history.cmd2', persistent_history_length=500)
+
+    # ... your class code here ...
+
+
+if __name__ == '__main__':
+    app = Cmd2PersistentHistory()
+    app.cmdloop()