Changeset 275:4465b569eab0

Timestamp:

08/11/11 22:13:56 (7 months ago)

Author:

Menno Smits <menno@…>

Branch:

default

Message:

doc updates to cover interact and livetest changes

Files:

• NEWS (modified) (1 diff)
• README (modified) (2 diffs)
• doc/src/index.rst (modified) (1 diff)

NEWS

@@ -35 +35 @@
 --------------
 * interact.py can now read livetest.py INI files (#66)
+* interact.py can now embed shells from ipython 0.10 and 0.11 (#98)
+* interact.py and livetest.py are now inside the imapclient package so
+  they can be used even when IMAClient has been installed from PyPI
+  (#82)
 * Added "debug" propety and setting of a log file (#90)
 * "normalise_times" attribute allows caller to select whether

README

@@ -111 +111 @@
 code.interact() function from the standard library is used.
 
+The interact functionality can also be accessed like this:
+
+    python -m imapclient.interact ...
+
+This works when IMAPClient has been installed from PyPI.
+
 
 livetest.py
@@ -132 +138 @@
 of the IMAP server.
 
+The livetest functionality can also be accessed like this:
+
+    python -m imapclient.livetest ...
+
+This works when IMAPClient has been installed from PyPI.
+
 
 Unit Tests

doc/src/index.rst

@@ -153 +153 @@
    :members:
 
-
+Interactive Sessions
+--------------------
+When developing program using IMAPClient is it sometimes useful to
+have an interactive shell to play with. IMAPClient ships with a module
+that lets you fire up an interactive shell with an IMAPClient instance
+connected to an IMAP server.
+
+Start a session like this::
+
+   python -m imapclient.interact -H <host> -u <user> ...
+
+Various options are available to specify the IMAP server details. See
+the help (--help) for more details. You'll be prompted for a username
+and password if one isn't provided on the command line.
+
+If installed, IPython will be used as the embedded shell. Otherwise
+the basic built-in Python shell will be used.
+
+Here's an example session::
+
+    $ python -m imapclient.interact -H <host> -u <user> ...
+    Connecting...
+    Connected.
+
+    IMAPClient instance is "c"
+    In [1]: c.select_folder('inbox')
+    Out[1]: 
+    {'EXISTS': 2,
+     'FLAGS': ('\\Answered',
+      '\\Flagged',
+      '\\Deleted',
+      '\\Seen',
+      '\\Draft'),
+     'PERMANENTFLAGS': ('\\Answered',
+      '\\Flagged',
+      '\\Deleted',
+      '\\Seen',
+      '\\Draft'),
+     'READ-WRITE': True,
+     'RECENT': 0,
+     'UIDNEXT': 1339,
+     'UIDVALIDITY': 1239278212}
+
+    In [2]: c.search()
+    Out[2]: [1123, 1233]
+
+    In [3]: c.logout()
+    Out[3]: 'Logging out'
+
+Note that the connected IMAPClient instance is available as the variable "c".