intersphinx-registry 0.2411.13__py2.py3-none-any.whl → 0.2411.25__py2.py3-none-any.whl

intersphinx_registry/__init__.py

@@ -11,7 +11,7 @@ from typing import Dict, Tuple, Set, Optional, cast
 # See issue 4, we this the best format is Major.YYMM.day,
 # in case of multiple releases a day we can borrow the next day's date.
 # no 0 in front of the day as it is not pep440 compliant.
-__version__ = "0.2411.13"
+__version__ = "0.2411.25"
 
 registry_file = Path(__file__).parent / "registry.json"
 

intersphinx_registry/_info.py

@@ -0,0 +1,80 @@
+"""
+Experimental, print info about all (or a subset of), all the known inventories.
+
+As this is likely to make _many_ concurrent connections; 
+we use aoihttp and sphobjinv which are not listed as dependencies.
+"""
+
+import asyncio
+import sys
+from urllib.parse import urljoin
+
+import aiohttp
+from sphobjinv import Inventory  # type: ignore
+
+from intersphinx_registry import get_intersphinx_mapping
+
+if len(sys.argv) not in [2, 3]:
+    sys.exit(
+        """Usage: python -m intersphinx_registry._info <package>[,package|:all]
+
+        This prints debug info about registered package.
+
+        WARNING: :all: will query _all_ the domains; this can be considered
+
+        """
+    )
+
+packages = set(sys.argv[1].split(","))
+if packages == {":all:"}:
+    from intersphinx_registry import _get_all_mappings
+
+    packages = set(list(_get_all_mappings().keys()))
+
+print("Looking up metadata for", len(packages), "package")
+
+# there will be only one url
+urls = [
+    (k, u[0], (u[1] if u[1] else "objects.inv"))
+    for k, u in get_intersphinx_mapping(packages=packages).items()
+]
+
+
+async def fetch(session, key, base_url, obj):
+    final_url = urljoin(base_url, obj)
+    if obj != "objects.inv":
+        print("Obj for ", base_url, obj)
+    async with session.get(final_url) as response:
+        return key, base_url, await response.read()
+
+
+async def fetch_all(urls):
+    async with aiohttp.ClientSession() as session:
+        tasks = [fetch(session, *url) for url in urls]
+        return await asyncio.gather(*tasks)
+
+
+results = asyncio.run(fetch_all(urls))
+
+flattened = []
+for key, base_url, data in results:
+    try:
+        inv = Inventory(zlib=data)
+    except Exception:
+        print("ERROR with", key, base_url, file=sys.stderr)
+        continue
+    flattened.append((key, base_url, inv.project, inv.version, inv.count))
+
+if not flattened:
+    sys.exit("Could not reach any pacakges")
+width = [len(x) for x in flattened[0][:-1]]
+
+for item in flattened:
+    width = [max(w, len(x)) for w, x in zip(width, item[:-1])]
+
+
+for key, url, proj, version, count in flattened:
+    w_key, w_url, w_proj, w_version = width
+    print(
+        f"{key:<{w_key}}  {proj!r:<{w_proj+2}} {version:<{w_version}} {count:<5} {url:<{w_url}}"
+    )

intersphinx_registry/lookup.py

@@ -1,21 +1,74 @@
 import sys
 
-from intersphinx_registry import get_intersphinx_mapping
-import logging as _logging
-from sphinx.ext.intersphinx import inspect_main
+from . import get_intersphinx_mapping
 from urllib.parse import urljoin
 
-if len(sys.argv) != 2:
-    sys.exit("Usage: python -m intersphinx_registry.lookup <package>")
+from typing import Optional
 
-packages = set([sys.argv[1]])
+from sphinx.util.inventory import InventoryFile
+from io import BytesIO
+
+import requests
+
+if len(sys.argv) not in [2, 3]:
+    sys.exit(
+        """Usage: python -m intersphinx_registry.lookup <package>[,package] [search_term]
+
+        Example:
+
+        $ python -m intersphinx_registry.lookup numpy,scipy array
+        $ python -m intersphinx_registry.lookup ipython formatters.html
+
+        """
+    )
+
+packages = set(sys.argv[1].split(","))
+
+search_term: Optional[str]
+if len(sys.argv) == 3:
+    search_term = sys.argv[2]
+else:
+    search_term = None
 
 # there will be only one url
 urls = [
-    urljoin(u[0], (u[1] if u[1] else "objects.inv"))
+    (u[0], (u[1] if u[1] else "objects.inv"))
     for u in get_intersphinx_mapping(packages=packages).values()
 ]
 
+flattened = []
+for base_url, obj in urls:
+
+    final_url = urljoin(base_url, obj)
+
+    resp = requests.get(final_url)
+
+    inv = InventoryFile.load(BytesIO(resp.content), base_url, urljoin)
+
+    for key, v in inv.items():
+        inv_entries = sorted(v.items())
+        for entry, (_proj, _ver, url_path, display_name) in inv_entries:
+            # display_name = display_name * (display_name != '-')
+            flattened.append((key, entry, _proj, _ver, display_name, url_path))
+
+filtered = []
+
+width = [len(x) for x in flattened[0]]
+
+for item in flattened:
+    key, entry, proj, version, display_name, url_path = item
+    if (
+        (search_term is None)
+        or (search_term in entry)
+        or (search_term in display_name)
+        or (search_term in url_path)
+    ):
+        filtered.append((key, entry, proj, version, display_name, url_path))
+        width = [max(w, len(x)) for w, x in zip(width, item)]
+
 
-_logging.basicConfig()
-raise SystemExit(inspect_main(urls))
+for key, entry, proj, version, display_name, url_path in filtered:
+    w_key, w_entry, w_proj, w_version, w_di, w_url = width
+    print(
+        f"{key:<{w_key}}  {entry:<{w_entry}}  {proj:<{w_proj}}  {version:<{w_version}}  {display_name!r:<{w_di+2}}  {url_path}"
+    )

intersphinx_registry/registry.json

@@ -1,7 +1,7 @@
 {
   "anndata": ["https://anndata.readthedocs.io/en/stable/", null],
-  "asdf-astropy": ["https://asdf-astropy.readthedocs.io/en/latest/", null],
-  "astropy-dev": ["https://docs.astropy.org/en/latest/", null],
+  "asdf-astropy": ["https://asdf-astropy.readthedocs.io/en/stable/", null],
+  "astropy-dev": ["https://docs.astropy.org/en/stable/", null],
   "asv": ["https://asv.readthedocs.io/en/stable/", null],
   "asyncssh": ["https://asyncssh.readthedocs.io/en/latest/", null],
   "attrs": ["https://www.attrs.org/en/stable/", null],
@@ -15,22 +15,20 @@
   "cartopy": ["https://scitools.org.uk/cartopy/docs/latest/", null],
   "cffi": ["https://cffi.readthedocs.io/en/latest/", null],
   "click": ["https://click.palletsprojects.com/", null],
+  "commonmark": ["https://commonmarkpy.readthedocs.io/en/stable/", null],
   "conda": ["https://conda.io/en/latest/", null],
   "configspace": ["https://automl.github.io/ConfigSpace/latest/", null],
   "cycler": ["https://matplotlib.org/cycler/", null],
   "cython": ["https://docs.cython.org/en/latest/", null],
   "dask": ["https://docs.dask.org/en/latest/", null],
-  "dateutil": ["https://dateutil.readthedocs.io/en/latest/", null],
+  "dateutil": ["https://dateutil.readthedocs.io/en/stable/", null],
   "devguide": ["https://devguide.python.org/", null],
   "devpi": ["https://devpi.net/docs/devpi/devpi/latest/+doc/", null],
   "dh-virtualenv": ["https://dh-virtualenv.readthedocs.io/en/latest/", null],
   "dipy": ["https://docs.dipy.org/stable/", null],
   "distlib": ["https://distlib.readthedocs.io/en/latest/", null],
   "distributed": ["https://distributed.dask.org/en/stable/", null],
-  "django": [
-    "https://docs.djangoproject.com/en/stable/",
-    "https://docs.djangoproject.com/en/stable/_objects/"
-  ],
+  "django": ["https://docs.djangoproject.com/en/stable/", "https://docs.djangoproject.com/en/stable/_objects/"],
   "dlpack": ["https://dmlc.github.io/dlpack/latest/", null],
   "flax": ["https://flax.readthedocs.io/en/latest/", null],
   "flexx": ["https://flexx.readthedocs.io/en/latest/", null],
@@ -38,19 +36,18 @@
   "geopandas": ["https://geopandas.org/en/stable/", null],
   "hub": ["https://jupyterhub.readthedocs.io/en/latest/", null],
   "imageio": ["https://imageio.readthedocs.io/en/stable/", null],
-  "importlib-resources": [
-    "https://importlib-resources.readthedocs.io/en/latest/",
-    null
-  ],
+  "iminuit": ["https://iminuit.readthedocs.io/en/stable/", null],
+  "importlib-resources": ["https://importlib-resources.readthedocs.io/en/latest/", null],
   "ipykernel": ["https://ipykernel.readthedocs.io/en/latest/", null],
   "ipyleaflet": ["https://ipyleaflet.readthedocs.io/en/latest/", null],
-  "ipyparallel": ["https://ipyparallel.readthedocs.io/en/latest/", null],
-  "ipython": ["https://ipython.readthedocs.io/en/latest/", null],
+  "ipyparallel": ["https://ipyparallel.readthedocs.io/en/stable/", null],
+  "ipython": ["https://ipython.readthedocs.io/en/stable/", null],
   "ipywidgets": ["https://ipywidgets.readthedocs.io/en/latest/", null],
   "jax": ["https://jax.readthedocs.io/en/latest/", null],
   "jedi": ["https://jedi.readthedocs.io/en/latest/", null],
   "jinja": ["https://jinja.palletsprojects.com/", null],
   "joblib": ["https://joblib.readthedocs.io/en/latest/", null],
+  "jsonpatch": ["https://python-json-patch.readthedocs.io/en/stable/", null],
   "jupyter": ["https://docs.jupyter.org/en/latest/", null],
   "jupyter-server": ["https://jupyter-server.readthedocs.io/en/stable/", null],
   "jupyter_core": ["https://jupyter-core.readthedocs.io/en/stable/", null],
@@ -75,10 +72,7 @@
   "mpmath": ["https://mpmath.org/doc/current/", null],
   "myst-nb": ["https://myst-nb.readthedocs.io/en/latest/", null],
   "myst-parser": ["https://myst-parser.readthedocs.io/en/latest/", null],
-  "napari_plugin_engine": [
-    "https://napari-plugin-engine.readthedocs.io/en/latest/",
-    null
-  ],
+  "napari_plugin_engine": ["https://napari-plugin-engine.readthedocs.io/en/latest/", null],
   "nbconvert": ["https://nbconvert.readthedocs.io/en/latest/", null],
   "nbformat": ["https://nbformat.readthedocs.io/en/latest/", null],
   "nbgitpuller": ["https://nbgitpuller.readthedocs.io/en/latest/", null],
@@ -104,12 +98,10 @@
   "pip": ["https://pip.pypa.io/en/latest/", null],
   "pipenv": ["https://pipenv.pypa.io/en/latest/", null],
   "piwheels": ["https://piwheels.readthedocs.io/en/latest/", null],
+  "plotly": ["https://plotly.com/python-api-reference/", null],
   "pluggy": ["https://pluggy.readthedocs.io/en/stable/", null],
   "poliastro": ["https://docs.poliastro.space/en/stable/", null],
-  "prompt_toolkit": [
-    "https://python-prompt-toolkit.readthedocs.io/en/stable/",
-    null
-  ],
+  "prompt_toolkit": ["https://python-prompt-toolkit.readthedocs.io/en/stable/", null],
   "py": ["https://pylib.readthedocs.io/en/latest/", null],
   "pyarrow": ["https://arrow.apache.org/docs/", null],
   "pybind11": ["https://pybind11.readthedocs.io/en/stable/", null],
@@ -134,6 +126,7 @@
   "readthedocs": ["https://docs.readthedocs.io/en/stable/", null],
   "referencing": ["https://referencing.readthedocs.io/en/stable/", null],
   "requests": ["https://docs.python-requests.org/en/latest/", null],
+  "rich": ["https://rich.readthedocs.io/en/stable/", null],
   "rpy2": ["https://rpy2.github.io/doc/latest/html/", null],
   "rst-to-myst": ["https://rst-to-myst.readthedocs.io/en/stable/", null],
   "rtd": ["https://docs.readthedocs.io/en/stable/", null],
@@ -153,24 +146,12 @@
   "spack": ["https://spack.readthedocs.io/en/latest/", null],
   "sparse": ["https://sparse.pydata.org/en/latest/", null],
   "sphinx": ["https://www.sphinx-doc.org/en/master/", null],
-  "sphinx-copybutton": [
-    "https://sphinx-copybutton.readthedocs.io/en/latest/",
-    null
-  ],
-  "sphinx-design": [
-    "https://sphinx-design.readthedocs.io/en/pydata-theme/",
-    null
-  ],
+  "sphinx-copybutton": ["https://sphinx-copybutton.readthedocs.io/en/latest/", null],
+  "sphinx-design": ["https://sphinx-design.readthedocs.io/en/pydata-theme/", null],
   "sphinx-gallery": ["https://sphinx-gallery.github.io/stable/", null],
   "sphinx-material": ["https://bashtage.github.io/sphinx-material/", null],
-  "sphinx-togglebutton": [
-    "https://sphinx-togglebutton.readthedocs.io/en/latest/",
-    null
-  ],
-  "sphinx_automodapi": [
-    "https://sphinx-automodapi.readthedocs.io/en/stable/",
-    null
-  ],
+  "sphinx-togglebutton": ["https://sphinx-togglebutton.readthedocs.io/en/latest/", null],
+  "sphinx_automodapi": ["https://sphinx-automodapi.readthedocs.io/en/stable/", null],
   "sqlalchemy": ["https://docs.sqlalchemy.org/en/latest/", null],
   "statsmodels": ["https://www.statsmodels.org/stable/", null],
   "sympy": ["https://docs.sympy.org/latest/", null],
@@ -183,6 +164,7 @@
   "typing": ["https://typing.readthedocs.io/en/latest/", null],
   "typing_extensions": ["https://typing-extensions.readthedocs.io/en/stable/", null],
   "ubelt": ["https://ubelt.readthedocs.io/en/latest/", null],
+  "uproot": ["https://uproot.readthedocs.io/en/stable/", null],
   "urwid": ["https://urwid.org/", null],
   "virtualenv": ["https://virtualenv.pypa.io/en/stable/", null],
   "writethedocs": ["https://www.writethedocs.org/", null],

intersphinx_registry-0.2411.25.dist-info/METADATA

@@ -0,0 +1,87 @@
+Metadata-Version: 2.3
+Name: intersphinx_registry
+Version: 0.2411.25
+Summary: This package provides convenient utilities and data to write a sphinx config file.
+Author-email: Matthias Bussonnier <bussonniermatthias@gmail.com>
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
+Requires-Dist: pytest>=7.0 ; extra == "tests"
+Requires-Dist: pytest-xdist ; extra == "tests"
+Requires-Dist: requests ; extra == "tests"
+Requires-Dist: mypy ; extra == "tests"
+Requires-Dist: types-requests ; extra == "tests"
+Project-URL: Home, https://github.com/Quansight-labs/intersphinx_registry
+Provides-Extra: tests
+
+# Intersphinx Registry
+
+A simple utility package that provide default inter sphinx mapping for a large chunk of the python ecosystem.
+
+Usage in `conf.py`
+
+```python
+from intersphinx_registry import get_intersphinx_mapping
+
+# ...
+intersphinx_mapping = get_intersphinx_mapping(
+    packages={"ipython", "matplotlib", "pandas", "python"}
+)
+intersphinx_mapping.update({
+    'overwrite': ('<url>', None),
+    'my-package' : ('<url>', None),
+})
+```
+
+## quick lookup
+
+You can use the following to lookup target/webpages of various packages.
+
+Call without arguments to get help:
+
+```
+$ python -m intersphinx_registry.lookup
+
+    Usage: python -m intersphinx_registry.lookup <package>[,package] [search_term]
+
+    Example:
+
+    $ python -m intersphinx_registry.lookup numpy,scipy array
+    $ python -m intersphinx_registry.lookup ipython formatters.html
+
+```
+
+You can search multiple packages as once.
+
+```
+$ python -m intersphinx_registry.lookup numpy,scipy Universal
+std:label ufuncs                             NumPy 2.1    'Universal functions (ufunc)'                         https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs
+std:label ufuncs-basics                      NumPy 2.1    'Universal functions (ufunc) basics'                  https://numpy.org/doc/stable/user/basics.ufuncs.html#ufuncs-basics
+std:label ufuncs-internals                   NumPy 2.1    'Universal functions'                                 https://numpy.org/doc/stable/dev/internals.code-explanations.html#ufuncs-internals
+std:doc   reference/ufuncs                   NumPy 2.1    'Universal functions (ufunc)'                         https://numpy.org/doc/stable/reference/ufuncs.html
+std:doc   user/basics.ufuncs                 NumPy 2.1    'Universal functions (ufunc) basics'                  https://numpy.org/doc/stable/user/basics.ufuncs.html
+std:label non-uniform-random-number-sampling SciPy 1.14.1 'Universal Non-Uniform Random Number Sampling in SciPy' https://docs.scipy.org/doc/scipy/tutorial/stats/sampling.html#non-uniform-random-number-sampling
+std:doc   tutorial/stats/sampling            SciPy 1.14.1 'Universal Non-Uniform Random Number Sampling in SciPy' https://docs.scipy.org/doc/scipy/tutorial/stats/sampling.html
+```
+
+Warning, there is no cache, it downloads the inventory of each mentioned package every time.
+
+
+## Why ?
+
+Sometime packages docs move and it's hard to keep track of. We _try_ to keep the
+registry up to date, so yo do not have to ask yourself questions and update your
+intersphinx-mapping.
+
+You also might not want to think about adding intersphinx mapping when you refer
+to dependencies.
+
+## A package url is wrong !
+
+Please send a PR updating only this package in the `registry.json`. We try to
+link only to _stable_ package, not dev versions.
+
+## A package is missing !
+
+We can't do all packages, but if you think a package is widely used and missing,
+please send a PR.
+

intersphinx_registry-0.2411.25.dist-info/RECORD

@@ -0,0 +1,9 @@
+intersphinx_registry/__init__.py,sha256=m7_gFh8hWex6xNVQ1143h-odCKfkSEzvjF-1NZZVF6c,1763
+intersphinx_registry/_info.py,sha256=wlicM8WkAaykwDkeyp5JRGgYOG3Kp7diu0bjBlYfH9M,2223
+intersphinx_registry/lookup.py,sha256=DpRhv55mMLE4Xyt1xBMXFB8voO7vXoZDqeqjGBDzoLw,2008
+intersphinx_registry/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+intersphinx_registry/registry.json,sha256=wnMgSTuwNoZxAcn7CgbLSGl2GxGkaZ92LiK3insqF40,11223
+intersphinx_registry-0.2411.25.dist-info/LICENSE,sha256=j98x_c52nvqkLlr-U8tUaubJG3IBCIFEInYE4L_Yqqo,1086
+intersphinx_registry-0.2411.25.dist-info/WHEEL,sha256=ssQ84EZ5gH1pCOujd3iW7HClo_O_aDaClUbX4B8bjKY,100
+intersphinx_registry-0.2411.25.dist-info/METADATA,sha256=LxQzJTNp7g8VfeQvQ7fG5BfpE0hHOQUvZt44e2uwOfA,3533
+intersphinx_registry-0.2411.25.dist-info/RECORD,,

intersphinx_registry-0.2411.13.dist-info/METADATA

@@ -1,69 +0,0 @@
-Metadata-Version: 2.3
-Name: intersphinx_registry
-Version: 0.2411.13
-Summary: This package provides convenient utilities and data to write a sphinx config file.
-Author-email: Matthias Bussonnier <bussonniermatthias@gmail.com>
-Description-Content-Type: text/markdown
-Classifier: License :: OSI Approved :: MIT License
-Requires-Dist: pytest>=7.0 ; extra == "tests"
-Requires-Dist: pytest-xdist ; extra == "tests"
-Requires-Dist: requests ; extra == "tests"
-Requires-Dist: mypy ; extra == "tests"
-Requires-Dist: types-requests ; extra == "tests"
-Project-URL: Home, https://github.com/Quansight-labs/intersphinx_registry
-Provides-Extra: tests
-
-# Intersphinx Registry
-
-A simple utility package that provide default inter sphinx mapping for a large chunk of the python ecosystem.
-
-Usage in `conf.py`
-
-```python
-from intersphinx_registry import get_intersphinx_mapping
-
-# ...
-intersphinx_mapping = get_intersphinx_mapping(
-    packages={"ipython", "matplotlib", "pandas", "python"}
-)
-intersphinx_mapping.update({
-    'overwrite': ('<url>', None),
-    'my-package' : ('<url>', None),
-})
-```
-
-## quick lookup
-
-You can use the following to lookup target/webpages of various packages.
-
-```
-$ python -m intersphinx_registry.lookup ipython | grep whatsnew7
-    whatsnew700                              IPython 7.0.0                           : whatsnew/version7.html#whatsnew700
-    whatsnew710                              IPython 7.1.0                           : whatsnew/version7.html#whatsnew710
-    whatsnew720                              IPython 7.2.0                           : whatsnew/version7.html#whatsnew720
-    whatsnew730                              IPython 7.3.0                           : whatsnew/version7.html#whatsnew730
-    whatsnew740                              IPython 7.4.0                           : whatsnew/version7.html#whatsnew740
-    whatsnew750                              IPython 7.5.0                           : whatsnew/version7.html#whatsnew750
-    whatsnew760                              IPython 7.6.0                           : whatsnew/version7.html#whatsnew760
-```
-
-
-## Why ?
-
-Sometime packages docs move and it's hard to keep track of. We _try_ to keep the
-registry up to date, so yo do not have to ask yourself questions and update your
-intersphinx-mapping.
-
-You also might not want to think about adding intersphinx mapping when you refer
-to dependencies.
-
-## A package url is wrong !
-
-Please send a PR updating only this package in the `registry.json`. We try to
-link only to _stable_ package, not dev versions.
-
-## A package is missing !
-
-We can't do all packages, but if you think a package is widely used and missing,
-please send a PR.
-

intersphinx_registry-0.2411.13.dist-info/RECORD

@@ -1,8 +0,0 @@
-intersphinx_registry/__init__.py,sha256=NmSZJwu9eyh0yv57FOUDXE3iZ4ggUpaMXKvb94q2wW4,1763
-intersphinx_registry/lookup.py,sha256=i5WhafTP97-Gv1n_RLpCZWb2HGIayockMHeg_IHxwBk,524
-intersphinx_registry/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-intersphinx_registry/registry.json,sha256=7HduIHRzcvq-3S7f0HI5VMDqleL5ozG94-e1aL6Jp7E,10913
-intersphinx_registry-0.2411.13.dist-info/LICENSE,sha256=j98x_c52nvqkLlr-U8tUaubJG3IBCIFEInYE4L_Yqqo,1086
-intersphinx_registry-0.2411.13.dist-info/WHEEL,sha256=ssQ84EZ5gH1pCOujd3iW7HClo_O_aDaClUbX4B8bjKY,100
-intersphinx_registry-0.2411.13.dist-info/METADATA,sha256=LNgo7mrK82pOcoITxqlAsl957hRQga2C3nStXQwHGWU,2678
-intersphinx_registry-0.2411.13.dist-info/RECORD,,