{
    "info": {
        "author": "Robert Kern",
        "author_email": "robert.kern@enthought.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Topic :: Software Development :: Documentation"
        ],
        "description": "WhooshDoc\n=========\n\nWhooshDoc is an indexed, full-text search tool for Python docstrings. It uses\nWhoosh_ to do the indexing and searching, hence the name. It includes tools for\ncollecting docstrings to index them and for searching the index.\n\nPrerequisites\n-------------\n\nFor searching a prepared index, all you need is Whoosh_. WhooshDoc uses epydoc_\nto traverse packages and collect their docstrings in order to build a search\nindex. However, epydoc is not required; you can add to a WhooshDoc index using\nthe Whoosh_ API (see whooshdoc/util.py for the schema), without using epydoc.\n\nThis package uses setuptools_ for installation and for locating a default \nWhooshDoc index. WhooshDoc uses argparse_ for command line arguments.\n\nInstallation\n------------\n\nYou can install WhooshDoc, along with its dependencies, using with setuptools'\neasy_install::\n\n    $ easy_install WhooshDoc\n\nor via the normal setup.py mechanism after downloading and unpacking the\ntarball::\n\n    $ cd WhooshDoc-1.0\n    $ python setup.py install\n\nTo use the wxPython_ search GUI, you must install Enthought's Traits_ and\nTraitsBackendWX_ packages. To do this, use the following easy_install command::\n\n    $ easy_install 'WhooshDoc[ui]'\n\nThe development source may be checked out via Subversion::\n\n    $ svn co https://svn.enthought.com/svn/enthought/WhooshDoc/trunk WhooshDoc\n\n\nwdoc\n----\n\nWhooshDoc comes with one script, wdoc. It has several sub-commands. Use\n\"wdoc --help\" and \"wdoc <sub-command> --help\" to see detailed help.\n\nTo index a package using epydoc to collect docstrings, use \"wdoc index\". For\nexample::\n\n    $ wdoc index numpy\n\nTo use the console search utility, use \"wdoc search\". For example::\n\n    $ wdoc search --help   # For an explanation of the query syntax.\n    $ wdoc search bessel or airy not filter\n    $ wdoc search '\"phrase searches need weird quoting\"'\n                  # because shells also interpret quote characters.\n\nTo use the wxPython_ GUI, use \"wdoc ui\". For example::\n\n    $ wdoc ui\n    $ wdoc ui bessel or airy not filter\n\nTo explicitly specify the WhooshDoc index directory, use the -i/--index option\nbefore any of these sub-commands. For example::\n\n    $ wdoc --index ~/Library/WhooshDoc search bessel\n\nTo remove certain docstrings (e.g., because you updated a package and want to\nreindex it), use \"wdoc delgroups\". For example::\n\n    # First, index a couple of scipy packages with the group name \"scipy\"\n    $ wdoc index --group scipy scipy.linalg scipy.optimize\n    # Now delete them.\n    $ wdoc delgroups scipy\n\n\nIPython\n-------\n\nWhooshDoc includes an IPython \"magic\" command, %whoosh, which performs a\nWhooshDoc query and presents the results in the console, like the \"wdoc search\"\ncommand. The %whoosh command integrates with IPython's help mechanisms to\ndisplay the help for the individual items. To enable it, add the following to\nyour `ipy_user_conf.py` file::\n\n    from whooshdoc.ipython import enable\n    enable('/path/to/whooshdoc/index')\n\nNow, you can search using %whoosh in IPython. For example::\n\n    In [10]: %whoosh bessel or airy not filter\n\n\nBugs\n----\n\nPlease make a ticket on the Enthought Tool Suite (ETS) Trac instance:\n\n    https://svn.enthought.com/enthought\n\nOr send an email to the enthought-dev mailing list:\n\n    https://mail.enthought.com/mailman/listinfo/enthought-dev\n\n\nTo Do\n-----\n\n* Simple web app using wsgiref.\n\n\n.. _Whoosh: http://whoosh.ca\n.. _epydoc: http://epydoc.sourceforge.net\n.. _setuptools: http://pypi.python.org/pypi/setuptools\n.. _argparse: http://pypi.python.org/pypi/argparse\n.. _wxPython: http://www.wxpython.org\n.. _Traits: http://pypi.python.org/pypi/Traits\n.. _TraitsBackendWX: http://pypi.python.org/pypi/TraitsBackendWX",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://pypi.python.org/pypi/WhooshDoc",
        "keywords": "",
        "license": "UNKNOWN",
        "maintainer": "",
        "maintainer_email": "",
        "name": "WhooshDoc",
        "package_url": "https://pypi.org/project/WhooshDoc/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/WhooshDoc/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "http://pypi.python.org/pypi/WhooshDoc"
        },
        "release_url": "https://pypi.org/project/WhooshDoc/1.0/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Index docstrings for full-text search.",
        "version": "1.0"
    },
    "last_serial": 739004,
    "releases": {
        "1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6d4ba8abf4d022a5b74d90fcb0e12bc3",
                    "sha256": "576b3156c7369bc0ac95dddacc83483eb0de317485f54370e0f57ad0e00c2e67"
                },
                "downloads": -1,
                "filename": "WhooshDoc-1.0-py2.5.egg",
                "has_sig": false,
                "md5_digest": "6d4ba8abf4d022a5b74d90fcb0e12bc3",
                "packagetype": "bdist_egg",
                "python_version": "2.5",
                "requires_python": null,
                "size": 38242,
                "upload_time": "2009-05-21T18:32:00",
                "url": "https://files.pythonhosted.org/packages/fa/af/dcdb343ff6ea97652b91ec1bd20c717bebfa8e74ea38d8c15f98153cbd0d/WhooshDoc-1.0-py2.5.egg"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "625bbe91223ed5887db7404603464774",
                    "sha256": "a03e64975029280aa0ed7581f6300f21d2290a0d440f8e8cf550f821e0434d91"
                },
                "downloads": -1,
                "filename": "WhooshDoc-1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "625bbe91223ed5887db7404603464774",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 17586,
                "upload_time": "2009-05-21T18:27:20",
                "url": "https://files.pythonhosted.org/packages/05/21/171f556106adf38e1ecf24131f0c4506f4b23d2c195c0f3eecb8d43ced59/WhooshDoc-1.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "6d4ba8abf4d022a5b74d90fcb0e12bc3",
                "sha256": "576b3156c7369bc0ac95dddacc83483eb0de317485f54370e0f57ad0e00c2e67"
            },
            "downloads": -1,
            "filename": "WhooshDoc-1.0-py2.5.egg",
            "has_sig": false,
            "md5_digest": "6d4ba8abf4d022a5b74d90fcb0e12bc3",
            "packagetype": "bdist_egg",
            "python_version": "2.5",
            "requires_python": null,
            "size": 38242,
            "upload_time": "2009-05-21T18:32:00",
            "url": "https://files.pythonhosted.org/packages/fa/af/dcdb343ff6ea97652b91ec1bd20c717bebfa8e74ea38d8c15f98153cbd0d/WhooshDoc-1.0-py2.5.egg"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "625bbe91223ed5887db7404603464774",
                "sha256": "a03e64975029280aa0ed7581f6300f21d2290a0d440f8e8cf550f821e0434d91"
            },
            "downloads": -1,
            "filename": "WhooshDoc-1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "625bbe91223ed5887db7404603464774",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 17586,
            "upload_time": "2009-05-21T18:27:20",
            "url": "https://files.pythonhosted.org/packages/05/21/171f556106adf38e1ecf24131f0c4506f4b23d2c195c0f3eecb8d43ced59/WhooshDoc-1.0.tar.gz"
        }
    ]
}