{
    "info": {
        "author": "Brian Skinn",
        "author_email": "bskinn@alum.mit.edu",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Environment :: Console",
            "Framework :: Sphinx",
            "Intended Audience :: Developers",
            "License :: OSI Approved",
            "License :: OSI Approved :: MIT License",
            "Natural Language :: English",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Programming Language :: Python :: 3 :: Only",
            "Topic :: Utilities"
        ],
        "description": "sphobjinv: Manipulate and inspect Sphinx objects.inv files\n==========================================================\n\n**Current Development Version:**\n\n.. image:: https://travis-ci.org/bskinn/sphobjinv.svg?branch=dev\n    :target: https://travis-ci.org/bskinn/sphobjinv\n\n.. image:: https://codecov.io/gh/bskinn/sphobjinv/branch/dev/graph/badge.svg\n    :target: https://codecov.io/gh/bskinn/sphobjinv\n\n**Most Recent Stable Release:**\n\n.. image:: https://img.shields.io/pypi/v/sphobjinv.svg\n    :target: https://pypi.org/project/sphobjinv\n\n.. image:: https://img.shields.io/pypi/pyversions/sphobjinv.svg\n\n**Info:**\n\n.. image:: https://img.shields.io/readthedocs/sphobjinv/v2.0.svg\n    :target: http://sphobjinv.readthedocs.io/en/v2.0/\n\n.. image:: https://img.shields.io/github/license/mashape/apistatus.svg\n    :target: https://github.com/bskinn/sphobjinv/blob/master/LICENSE.txt\n\n----\n\n**Using Sphinx?**\n\n**Having trouble writing cross-references?**\n\n``sphobjinv`` (short for '**sph**\\ inx **obj**\\ ects.\\ **inv**') can help!\n\nThe syntax required for a functional Sphinx cross-reference is highly\nnon-obvious in many cases. Sometimes Sphinx can guess correctly what\nyou mean, but it's pretty hit-or-miss.  The best approach is to provide\nSphinx with a completely specified cross-reference, and that's where\n``sphobjinv`` comes in.\n\nAfter a ``pip install sphobjinv``, find the documentation set you want\nto cross-reference into, and pass it to ``sphobjinv suggest``.\n\nFor internal cross-references, locate ``objects.inv`` within ``build/html``::\n\n    $ sphobjinv suggest doc/build/html/objects.inv as_rst -st 50\n\n      Name                                                        Score\n    -----------------------------------------------------------  -------\n    :py:attribute:`sphobjinv.data.SuperDataObj.as_rst`             60\n    :py:function:`sphobjinv.cmdline.getparser`                     50\n    :py:attribute:`sphobjinv.data.DataObjBytes.as_str`             50\n    :py:attribute:`sphobjinv.data.DataObjStr.as_str`               50\n    :py:attribute:`sphobjinv.data.SuperDataObj.as_str`             50\n    :py:attribute:`sphobjinv.inventory.Inventory.objects_rst`      50\n\n.. end shell command\n\nThe ``-s`` argument in the above shell command indicates to print the\n``fuzzywuzzy`` match score along with each search result, and ``-t 50``\nchanges the reporting threshold for the match score.\n\nFor external references, just find the documentation wherever it lives on the web,\nand pass ``sphobjinv suggest`` a URL from within the documentation set\nwith the ``--url/-u`` flag. For example, say I need to know how to\ncross-reference the ``redirect()`` function from Flask (see\n`here <http://flask.pocoo.org/docs/1.0/api/?highlight=redirect#flask.redirect>`__)::\n\n    $ sphobjinv suggest http://flask.pocoo.org/docs/1.0/views/#method-hints redirect -su\n\n    No inventory at provided URL.\n    Attempting \"http://flask.pocoo.org/docs/1.0/views/objects.inv\" ...\n    Attempting \"http://flask.pocoo.org/docs/1.0/objects.inv\" ...\n    Remote inventory found.\n\n      Name                            Score\n    -------------------------------  -------\n    :py:function:`flask.redirect`      90\n\n.. end shell command\n\n**NOTE** that the results from ``sphobjinv suggest`` are printed using the longer\n*block directives*, whereas cross-references must be composed using the\n*inline directives*. Thus, the above ``redirect()`` function must be\ncross-referenced as ``:func:`flask.redirect```, **not**\n``:function:`flask.redirect```.\n\n**Need to edit an inventory after it's created, or compose one from scratch?**\n\n``sphobjinv`` can help with that, too.\n\n``objects.inv`` files can be decompressed to plaintext at the commandline::\n\n    $ sphobjinv convert plain -o doc/build/html/objects.inv doc/scratch/\n    Conversion completed.\n    '...objects.inv' converted to '...objects.txt' (plain).\n\n.. end shell command\n\nJSON output is supported (``sphobjinv convert json ...``), and\ninventories can be re-compressed to the\npartially-zlib-compressed form that ``intersphinx`` reads\n(``sphobjinv convert zlib ...``).\n\nAlternatively, ``sphobjinv`` exposes an API to enable automation of\ninventory creation/modification::\n\n    >>> import sphobjinv as soi\n    >>> inv = soi.Inventory('doc/build/html/objects.inv')\n    >>> print(inv)\n    <Inventory (fname_zlib): sphobjinv v2.0, 195 objects>\n    >>> inv.project\n    'sphobjinv'\n    >>> inv.version\n    '2.0'\n    >>> inv.objects[0]\n    DataObjStr(name='sphobjinv.cmdline', domain='py', role='module', priority='0', uri='cli/implementation.html#module-$', dispname='-')\n\nThe API also enables straightforward re-export of an inventory,\nfor subsequent use with ``intersphinx`` cross-references.\nSee `the docs <http://sphobjinv.readthedocs.io/en/v2.0/\napi_usage.html#exporting-an-inventory>`__\nfor more details.\n\n----\n\nFull documentation is hosted at\n`Read The Docs <http://sphobjinv.readthedocs.io/en/v2.0/>`__.\n\nAvailable on `PyPI <https://pypi.python.org/pypi/sphobjinv>`__\n(``pip install sphobjinv``).\n\nSource on `GitHub <https://github.com/bskinn/sphobjinv>`__.  Bug reports\nand feature requests are welcomed at the\n`Issues <https://github.com/bskinn/sphobjinv/issues>`__ page there.\n\nCopyright (c) Brian Skinn 2016-2018\n\nLicense: The MIT License. See `LICENSE.txt <https://github.com/bskinn/sphobjinv/blob/master/LICENSE.txt>`__\nfor full license terms.\n\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/bskinn/sphobjinv",
        "keywords": "",
        "license": "MIT License",
        "maintainer": "",
        "maintainer_email": "",
        "name": "sphobjinv",
        "package_url": "https://pypi.org/project/sphobjinv/",
        "platform": "",
        "project_url": "https://pypi.org/project/sphobjinv/",
        "project_urls": {
            "Homepage": "https://github.com/bskinn/sphobjinv"
        },
        "release_url": "https://pypi.org/project/sphobjinv/2.0/",
        "requires_dist": [
            "attrs (>=17.1)",
            "certifi",
            "fuzzywuzzy (>=0.3)",
            "jsonschema (>=2.0)"
        ],
        "requires_python": ">=3.4",
        "summary": "Sphinx objects.inv Inspection/Manipulation Tool",
        "version": "2.0"
    },
    "last_serial": 4769607,
    "releases": {
        "1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6ea1948ce98e60cb30948b9a75caecf8",
                    "sha256": "3fe495411aef1205b034d7efb56d847d2da8432f3c1f11a378adf8182e279fbe"
                },
                "downloads": -1,
                "filename": "sphobjinv-1.0-py3.5.egg",
                "has_sig": false,
                "md5_digest": "6ea1948ce98e60cb30948b9a75caecf8",
                "packagetype": "bdist_egg",
                "python_version": "3.5",
                "requires_python": null,
                "size": 8900,
                "upload_time": "2016-05-24T15:19:57",
                "url": "https://files.pythonhosted.org/packages/de/64/5ea78ebab1b21a7715bda25c90d737297c75abf47cd81e314af0daeaa84a/sphobjinv-1.0-py3.5.egg"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "395cbcbb4fcdc0a74148445afd70b030",
                    "sha256": "4ecfb9ca63d610f4bf2f2c56c1bef27ee4ced198a5d70e65a17c884ba20c2fac"
                },
                "downloads": -1,
                "filename": "sphobjinv-1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "395cbcbb4fcdc0a74148445afd70b030",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 6306,
                "upload_time": "2016-05-24T15:19:52",
                "url": "https://files.pythonhosted.org/packages/8d/d8/5d0cf748f084ef1b92764cf03c884bfb11245ac236772b125ce86d638ff2/sphobjinv-1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "372994f5ca7377db2dbd591f2d6a198f",
                    "sha256": "8b013777c98af44dda2c5ccb285cbf28e8b2e26e9fa2be24042614ae1c1f531d"
                },
                "downloads": -1,
                "filename": "sphobjinv-1.0.zip",
                "has_sig": false,
                "md5_digest": "372994f5ca7377db2dbd591f2d6a198f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7924,
                "upload_time": "2016-05-24T15:20:28",
                "url": "https://files.pythonhosted.org/packages/43/1c/5193d9e9f5d3365f7903617333cbd15023e5196d4fc02af6a2c7dd2afbd7/sphobjinv-1.0.zip"
            }
        ],
        "1.0.post1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d95da94a8b8de3a33a906672394bfbf4",
                    "sha256": "9dd376e4fd7c904fd5a1ad5efe80ac28dbf32bbb675457b1b59868f4b9c4ae83"
                },
                "downloads": -1,
                "filename": "sphobjinv-1.0.post1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "d95da94a8b8de3a33a906672394bfbf4",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 6472,
                "upload_time": "2018-01-29T18:39:16",
                "url": "https://files.pythonhosted.org/packages/73/29/d63cc736c977cdd103d4b47cad86cc8afbe7eac41f4a7aa03843ab34bbc1/sphobjinv-1.0.post1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "728b00fd65f1e2655d492cd389c58f75",
                    "sha256": "5c4842fae7617ce5d86f3fd8448a12fac06dedeb23e611912914182c4a0bc41a"
                },
                "downloads": -1,
                "filename": "sphobjinv-1.0.post1.tar.gz",
                "has_sig": false,
                "md5_digest": "728b00fd65f1e2655d492cd389c58f75",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5273,
                "upload_time": "2018-01-29T18:39:04",
                "url": "https://files.pythonhosted.org/packages/17/c0/6ed1a1a5e5f90d8a91d87b6dc91908e95b50370dfcfcbdc5390f347c9236/sphobjinv-1.0.post1.tar.gz"
            }
        ],
        "2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ecd6762db8983c50923d94af82a897a2",
                    "sha256": "999587a951f6940c8017c0ca824b8de262347862bd015cefa79b40fa0e7223e0"
                },
                "downloads": -1,
                "filename": "sphobjinv-2.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "ecd6762db8983c50923d94af82a897a2",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.4",
                "size": 28526,
                "upload_time": "2018-08-16T05:10:18",
                "url": "https://files.pythonhosted.org/packages/4a/f7/1ef4b0effb2680ce5b1d5c64711ad543beb8054b0898e1003ad2b48544f7/sphobjinv-2.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "92f3f4eb9ad925a54bf5d4ca5bba233e",
                    "sha256": "203b5cb42b55873e573e58a8638f8bd07d2b02bda1bf4426febc60413fa4acde"
                },
                "downloads": -1,
                "filename": "sphobjinv-2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "92f3f4eb9ad925a54bf5d4ca5bba233e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.4",
                "size": 27965,
                "upload_time": "2018-08-16T05:10:30",
                "url": "https://files.pythonhosted.org/packages/25/b5/a6fa7be66b9e23444cbbc35078d29faeecc7119f2de89af8e016731c2cd9/sphobjinv-2.0.tar.gz"
            }
        ],
        "2.0.1rc1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8f7f748099fec7c49c254fbe09ba7fb5",
                    "sha256": "28d2a20a4e50bf8d636002229eb6e2790d24ff6a6079d7bf7368cefd2bff0c4d"
                },
                "downloads": -1,
                "filename": "sphobjinv-2.0.1rc1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "8f7f748099fec7c49c254fbe09ba7fb5",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.4",
                "size": 29663,
                "upload_time": "2019-02-01T19:13:46",
                "url": "https://files.pythonhosted.org/packages/52/64/654df0ae3595a86636982ab2c6c82e46a712fa9a29f700e7e5733d6dfde4/sphobjinv-2.0.1rc1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "3a4ef3306c86155872e8ff05c1f622fa",
                    "sha256": "78402d7f16d4c55c4250c5d4c89688f2c448054bc7863f9714e24024a24889dd"
                },
                "downloads": -1,
                "filename": "sphobjinv-2.0.1rc1.tar.gz",
                "has_sig": false,
                "md5_digest": "3a4ef3306c86155872e8ff05c1f622fa",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.4",
                "size": 27971,
                "upload_time": "2019-02-01T19:13:37",
                "url": "https://files.pythonhosted.org/packages/3e/d9/f9847a9c60743656c2c5cad8fe42cd02567c9ac9b952675a3a340c00516e/sphobjinv-2.0.1rc1.tar.gz"
            }
        ],
        "2.0rc1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "858f588cfeca799d04ce0076c1b1f545",
                    "sha256": "1b9cac4b27c9ac6e6bc3be79e4ad585df75b95305ca3e908c5bc3f20ebf4ead4"
                },
                "downloads": -1,
                "filename": "sphobjinv-2.0rc1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "858f588cfeca799d04ce0076c1b1f545",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.4",
                "size": 29128,
                "upload_time": "2018-05-18T05:19:25",
                "url": "https://files.pythonhosted.org/packages/fe/a8/c1fd73009bd84e980ae93bbd02a5b976d83b2404a0dc1ae52ca7d2ba9a31/sphobjinv-2.0rc1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "dd743b7b494b0eb756f1dc9912767a3d",
                    "sha256": "6f701a3880d8f7a3471485a01a71c68a4a62607e06076c2ff29cb2d01494c5d9"
                },
                "downloads": -1,
                "filename": "sphobjinv-2.0rc1.tar.gz",
                "has_sig": false,
                "md5_digest": "dd743b7b494b0eb756f1dc9912767a3d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.4",
                "size": 23334,
                "upload_time": "2018-05-18T04:55:46",
                "url": "https://files.pythonhosted.org/packages/fc/6e/d185c514fb1a8cd5e700dc393bc66b65e03d43950d20ea6a7d90ed20ab34/sphobjinv-2.0rc1.tar.gz"
            }
        ],
        "v0.1": []
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ecd6762db8983c50923d94af82a897a2",
                "sha256": "999587a951f6940c8017c0ca824b8de262347862bd015cefa79b40fa0e7223e0"
            },
            "downloads": -1,
            "filename": "sphobjinv-2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ecd6762db8983c50923d94af82a897a2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.4",
            "size": 28526,
            "upload_time": "2018-08-16T05:10:18",
            "url": "https://files.pythonhosted.org/packages/4a/f7/1ef4b0effb2680ce5b1d5c64711ad543beb8054b0898e1003ad2b48544f7/sphobjinv-2.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "92f3f4eb9ad925a54bf5d4ca5bba233e",
                "sha256": "203b5cb42b55873e573e58a8638f8bd07d2b02bda1bf4426febc60413fa4acde"
            },
            "downloads": -1,
            "filename": "sphobjinv-2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "92f3f4eb9ad925a54bf5d4ca5bba233e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.4",
            "size": 27965,
            "upload_time": "2018-08-16T05:10:30",
            "url": "https://files.pythonhosted.org/packages/25/b5/a6fa7be66b9e23444cbbc35078d29faeecc7119f2de89af8e016731c2cd9/sphobjinv-2.0.tar.gz"
        }
    ]
}