Version 0.3

This version allows you to supply multiple module names to pydiction.py and it will auto-append them to the pydiction file. The included pydiction file now contains support for wxPython and Twisted.

Author: rkulla

README.orig

@@ -1,34 +1,65 @@
-pydiction README
------------------
+Pydiction
+Version: 0.3
+Author: Ryan (gt3) Kulla. ambiod@sbcglobal.net 
+Date: Dec 2003 
 
-CONTENTS
---------
 
-1) About Pydiction
-2) How to add your own modules to the pydiction dictionary file
+Description: pydiction is a special dictionary file of Python modules for use with vim's completion feature.
+             Pydiction.py is a program that generates the pydiction file and you can use it to add your 
+             project's own modules to it.
 
-===========================================================================================
+             When you supply a module name to pydiction.py it will generate the modules contents in 2 forms. 
+             The first form will be a list of the modules contents with the module name prefixed such as:
 
-ABOUT PYDICTION
----------------
-About Pydiction
-Author: Ryan Kulla
+                  module.function1(
+                  module.function1(
+                  module.nonfunction1
+                  module.nonfunction2
+                  ...
 
-Description: pydiction is a special dictionary file of common Python modules/methods/keywords for use with 
-             vim's auto-completion feature.
+              The first format is useful when you "import module" and are required to type the module prefix.
+              
+              The second form will be a list of just the module's method names without the module prefix:
+         
+                  function1(
+                  function2(
+                  nonfunction1
+                  nonfunction2
+                  ...
+  
+              The second form is useful when you "from module import functions".
 
-Usage: 
-Put the following 2 lines in your vimrc file:
 
-     set complete+=k
-     set dictionary+=/path/to/pydiction
+"pydiction.py" Usage:
 
-Now you can simply hit Ctrl-n or Cntrl-p to autocomplete Python module/keyword names.
+    pydiction.py module1 module2..
+
+Example: The following will append all the time and math module's attributes to the file "pydiction" with 
+         and without the  "time." and "math." prefixes:   
+
+    pydiction.py time math
+
+If you supply the -v option to pydiction.py it will dump the output to your screen instead of appending it
+to the pydiction file:
+
+    pydiction.py -v time math
+
+
+"pydiction dictionary file" Usage: 
+Put the following lines in your vimrc file:
+
+   set complete+=k
+   set isk+=.
+   set isk+=(
+   set dictionary+=/path/to/pydiction
+
+Now you can simply hit Control-n (n=next) or Control-p (p=previous) to complete Python code.
+(type ":help completion" in vim for more details)
 
 Example:
 Typing the following (in insert mode):
 
-    os.lis
+    os.lis<Ctrl-n>
 
 will expand to:
 
@@ -37,22 +68,33 @@ will expand to:
 You can also leave out the module.
 Example:
 
-    lis
+    lis<Ctrl-n>
 
 will expand to:
 
     listdir(
 
+More examples:
+
+    la<Ctrl-n> = lambda
+    wx<Ctrl-n> = wxPython
+    twisted.pr<Ctrl-n> = twisted.protocols (Keep hitting Ctrl-n to see twisted.protocols.*)
+    __b<Ctrl-n> = __builtin__ (Ctrl-n again = __builtins__)
+    sys.getr<Ctrl-n> = sys.getrecursionlimit(
+    sy<Ctrl-n> = sys.getrecursionlimit( (Vim remembers you've just used it)
+
 If there are multiple entries for an abbreviation, you'll be givin a list of names to choose from.
 
-Supported Python Modules: 
-__builtin__, __main__, __future__, os, os.walk, sys, datetime, time, locale, atexit, readline, rlcompleter, 
-types, UserDict, UserList, UserString, operator, inspect, traceback, linecache, pickle, cPickle, copy_reg, 
-shelve, copy, marshal, warnings, imp, pkgutil, code, codeop, pprint, repr, new, site, user, string, re, 
-struct, difflib, fpformat, StringIO, cStringIO, textwrap, codecs, encodings, unicodedata, stringprep, pydoc,
-doctest, unittest, test, math, cmath, random, whrandom, bisect, heapq, array, sets, itertools, ConfigParser, 
-fileinput, xreadlines, cmd, shlex, dircache, stat, statcache, statvfs, filecmp, popen2, sched, mutex, getpass, 
-curses, getopt, optparse, tempfile, errno, glob, fnmatch, shutil, gettext, logging, signal, socket, select,
+
+Currently Supported Python Modules: 
+__builtin__, __main__, __future__, os, os.walk, sys, datetime, time, locale, 
+atexit, readline, rlcompleter, types, UserDict, UserList, UserString, operator, inspect, traceback, 
+linecache, pickle, cPickle, copy_reg, shelve, copy, marshal, warnings, imp, pkgutil, code, codeop, 
+pprint, repr, new, site, user, string, re, struct, difflib, fpformat, StringIO, cStringIO, textwrap,
+codecs, encodings, unicodedata, stringprep, pydoc, doctest, unittest, test, math, cmath, random,
+whrandom, bisect, heapq, array, sets, itertools, ConfigParser, fileinput, xreadlines, cmd, shlex,
+dircache, stat, statcache, statvfs, filecmp, popen2, sched, mutex, getpass, curses, getopt, 
+optparse, tempfile, errno, glob, fnmatch, shutil, gettext, logging, signal, socket, select,
 thread, threading, dummy_thread, dummy_threading, Queue, mmap, anydbm, dbhash, whichdb, bsddb,
 dumbdbm, zlib, gzip, bz2, zipfile, tarfile, posix, pwd, grp, crypt, dl, gdbm, termios, tty, pty,
 fcntl, pipes, resource, syslog, commands, pdb, profile, hotshot, timeit, webbrowser, cgi, cgitb,
@@ -65,35 +107,17 @@ xml.dom.pulldom, xml.sax, xml.sax.handler, xml.sax.saxutils, xml.sax.xmlreader,
 aifc, sunau, wave, chunk, colorsys, rgbimg, imghdr, sndhdr, hmac, md5, sha, rotor, Tkinter, Tix, 
 ScrolledText, turtle, rexec, Bastion, parser, symbol, token, keyword, tokenize, tabnanny, pyclbr, 
 py_compile, compileall, dis, distutils, compiler, compiler.ast, compiler.visitor, msvcrt, _winreg,
-winsound, pygame, pygame.rect, pygame.surface, pygame.cdrom, pygame.display, pygame.draw, pygame.event,
-pygame.font, pygame.image, pygame.joystick, pygame.key, pygame.mixer, pygame.mixer.music, pygame.mouse,
-pygame.movie, pygame.sndarray, pygame.surfarray, pygame.time, pygame.transform, pygame.color, 
-pygame.cursors, pygame.sprite
+winsound, pygame, wxPython, twisted
 
-Supported Python Keywords:
+Currently Supported Keywords:
 and       del       for       is        raise
 assert    elif      from      lambda    return   
 break     else      global    not       try      
 class     except    if        or        while    
 continue  exec      import    pass      yield    
 def       finally   in        print
 
-========================================================================================================
-
-
-HOW TO ADD YOUR OWN MODULES TO THE PYDICTION DICTIONARY FILE
-------------------------------------------------------------
-
-pydiction.py is used for creating a dictionary of Python's module/method names for vim's completion feature.
-
-If you're working on a big project you might want to add your projects own module/method/etc names to the
-pydiction file so you can auto-complete those names as well.
-
-Usage: 
-
-    pydiction.py <module-name> >>pydiction
+---
+Other modules will be supported in future versions
 
-Example: The following will append all the time module's methods to the file "pydiction" with 
-         and without the "time." prefix:   
 
-    pydiction.py time >>pydiction