About
=====
Automatic generate to Zsh Completion Function from
Python's Option Parser Modules.

Now, It corresponds to `argparse`_ module and `optparse`_ module.

I write this module because I want to be created `grin`_ command's
Zsh Completion Function.

.. _`argparse`: http://code.google.com/p/argparse/
.. _`grin`: http://pypi.python.org/pypi/grin
.. _`optparse`: http://docs.python.org/library/optparse.html


Install
=======
used to pip::

    $ pip install genzshcomp

used to easy_install::

    $ easy_install genzshcomp


Require
=======
* Python2.6+


Usage
=====
show example dir...

from code of option parser object
---------------------------------

basic usage::

    ## gen.py
    from genzshcomp import ZshCompletionGenerator
    from optparse import OptionParser
    parser = OptionParser()
    generator = ZshCompletionGenerator(command_name, parser)
    print generator.get()

and zsh completion setups::

    $ python gen.py > ~/.zsh/comp/_command
    $ echo "fpath=(~/.zsh/comp/ $fpath)" >> ~/.zshrc
    $ echo "autoload -U ~/.zsh/comp/*(:t)" >> ~/.zshrc
    $ echo "autoload -Uz compinit" >> ~/.zshrc

from help-strings
-----------------

basic usage and zsh completion setups (ex.pep8 command)::

    $ pep8 --help > pep8help.txt
    $ genzshcomp pep8help.txt > ~/.zsh/comp/_pep8
    $ echo "fpath=(~/.zsh/comp/ $fpath)" >> ~/.zshrc
    $ echo "autoload -U ~/.zsh/comp/*(:t)" >> ~/.zshrc
    $ echo "autoload -Uz compinit" >> ~/.zshrc

using shell pipe::

    $ pep8 --help | genzshcomp > ~/.zsh/comp/_pep8
    # As follows...

