Metadata-Version: 1.1
Name: genzshcomp
Version: 0.5.1
Summary: Automatic generated to zsh completion function, for Python's Option Parser Modules.
Home-page: http://bitbucket.org/hhatto/genzshcomp/
Author: Hideo Hattori
Author-email: hhatto.jp@gmail.com
License: New BSD License
Description: 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 CompletionGenerator
            from optparse import OptionParser
            parser = OptionParser()
            generator = CompletionGenerator(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...
        
        Support Bash Completion
        -----------------------
        using shell pipe::
        
            $ pep8 --help | genzshcomp -f bash > /etc/bash_completion.d/pep8
            $ bash
        
        
        Support commands
        ================
        - `grin/grind`_ (*grin --help*)
        - gunicorn_ (*gunicorn --help*)
        - markdown2_ (*markdown2 --help*)
        - paver_ (*paver --help*)
        - pep8_ (*pep8 --help*)
        - pylint_ (*pylint --long-help*)
        
        and...
        
        .. _`grin/grind`: http://pypi.python.org/pypi/grin
        .. _gunicorn: http://gunicorn.org/
        .. _markdown2: http://code.google.com/p/python-markdown2/
        .. _paver: http://paver.github.com/paver/
        .. _pep8: http://pypi.python.org/pypi/pep8
        .. _pylint: http://www.logilab.org/857
        
Keywords: auto automation bash zsh completion
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: Operating System :: Unix
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Unix Shell
Classifier: Topic :: System :: Shells
