pyrefdev 2025.4__tar.gz → 2025.6__tar.gz

{pyrefdev-2025.4 → pyrefdev-2025.6}/.gitignore

@@ -1,4 +1,5 @@
 .DS_Store
+api-docs/
 
 # Hatch-managed version file
 src/pyrefdev/_version.py

pyrefdev-2025.6/.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+- repo: local
+  hooks:
+  - id: update-landing-page
+    name: Update landing page
+    language: system
+    entry: uv run pyrefdev-indexer update-landing-page
+    pass_filenames: false
+    files: \.(py|yaml)$
+    verbose: true

pyrefdev-2025.6/CHANGELOG.md

@@ -0,0 +1,115 @@
+# Changelog
+
+## [Unreleased]
+
+Nothing noticeable unreleased.
+
+## v2025.6
+
+- Added a `-p/--print` flag to the `pyrefdev` CLI to print the URL instead of opening it in the browser.
+- Support [cyclopts](https://cyclopts.readthedocs.io/en/latest/).
+- Support [yib](https://yib.readthedocs.io/en/latest/).
+
+## v2025.5
+
+- Added `add-docs`, `update-docs`, and `update-landing-page` commands to `pyrefdev-indexer`.
+- Added missing module symbols.
+- Support [aiohttp](https://docs.aiohttp.org/en/stable/).
+- Support [aioitertools](https://aioitertools.omnilib.dev/en/stable/).
+- Support [aiosignal](https://aiosignal.aio-libs.org/en/stable/).
+- Support [anyio](https://anyio.readthedocs.io/en/stable/).
+- Support [apache-beam](https://beam.apache.org/releases/pydoc/current/).
+- Support [arrow](https://arrow.readthedocs.io/en/latest/).
+- Support [attrs](https://www.attrs.org/en/stable/).
+- Support [azure-identity](https://azuresdkdocs.z19.web.core.windows.net/python/azure-identity/latest/index.html).
+- Support [boto3](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html).
+- Support [botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html).
+- Support [cachetools](https://cachetools.readthedocs.io/en/latest/).
+- Support [cattrs](https://catt.rs/en/stable/).
+- Support [charset-normalizer](https://charset-normalizer.readthedocs.io/en/latest/).
+- Support [click](https://click.palletsprojects.com/en/stable/).
+- Support [coverage](https://coverage.readthedocs.io/en/latest/).
+- Support [cryptography](https://cryptography.io/en/latest/).
+- Support [distlib](https://distlib.readthedocs.io/en/latest/).
+- Support [fastapi](https://fastapi.tiangolo.com/reference/).
+- Support [fastjsonschema](https://horejsek.github.io/python-fastjsonschema/).
+- Support [filelock](https://py-filelock.readthedocs.io/en/latest/).
+- Support [flask](https://flask.palletsprojects.com/en/stable/).
+- Support [frozenlist](https://frozenlist.aio-libs.org/en/latest/).
+- Support [fsspec](https://filesystem-spec.readthedocs.io/en/latest/).
+- Support [google-api-core](https://googleapis.dev/python/google-api-core/latest/).
+- Support [google-auth](https://googleapis.dev/python/google-auth/latest/).
+- Support [grpcio](https://grpc.github.io/grpc/python/index.html).
+- Support [h11](https://h11.readthedocs.io/en/latest/).
+- Support [h5py](https://docs.h5py.org/en/stable/).
+- Support [httplib2](https://httplib2.readthedocs.io/en/latest/).
+- Support [ipython](https://ipython.readthedocs.io/en/stable/).
+- Support [jinja2](https://jinja.palletsprojects.com/en/latest/).
+- Support [jsonschema](https://python-jsonschema.readthedocs.io/en/stable/).
+- Support [jupyter-core](https://jupyter-core.readthedocs.io/en/latest/).
+- Support [markupsafe](https://markupsafe.palletsprojects.com/en/stable/).
+- Support [matplotlib](https://matplotlib.org/stable/api/index.html).
+- Support [more-itertools](https://more-itertools.readthedocs.io/en/stable/).
+- Support [multidict](https://multidict.aio-libs.org/en/stable/).
+- Support [nbformat](https://nbformat.readthedocs.io/en/latest/).
+- Support [networkx](https://networkx.org/documentation/stable/reference/index.html).
+- Support [numba](https://numba.readthedocs.io/en/stable/reference/index.html).
+- Support [oauthlib](https://oauthlib.readthedocs.io/en/latest/).
+- Support [packaging](https://packaging.pypa.io/en/stable/).
+- Support [pathspec](https://python-path-specification.readthedocs.io/en/latest/index.html).
+- Support [pillow](https://pillow.readthedocs.io/en/stable/).
+- Support [platformdirs](https://platformdirs.readthedocs.io/en/latest/).
+- Support [pluggy](https://pluggy.readthedocs.io/en/latest/).
+- Support [propcache](https://propcache.aio-libs.org/en/latest/).
+- Support [protobuf](https://googleapis.dev/python/protobuf/latest/).
+- Support [psutil](https://psutil.readthedocs.io/en/latest/).
+- Support [pyarrow](https://arrow.apache.org/docs/python/api.html).
+- Support [pyasn1](https://pyasn1.readthedocs.io/en/latest/contents.html).
+- Support [pydantic-core](https://docs.pydantic.dev/latest/).
+- Support [pydantic](https://docs.pydantic.dev/latest/).
+- Support [pygments](https://pygments.org/docs/api/).
+- Support [pyjwt](https://pyjwt.readthedocs.io/en/stable/).
+- Support [pyOpenSSL](https://www.pyopenssl.org/en/latest/).
+- Support [pyparsing](https://pyparsing-docs.readthedocs.io/en/latest/).
+- Support [pytest](https://docs.pytest.org/en/stable/reference/index.html).
+- Support [requests-oauthlib](https://requests-oauthlib.readthedocs.io/en/latest/).
+- Support [requests-toolbelt](https://toolbelt.readthedocs.io/en/latest/index.html).
+- Support [rich](https://rich.readthedocs.io/en/latest/).
+- Support [rpds-py](https://rpds.readthedocs.io/en/latest/).
+- Support [s3fs](https://s3fs.readthedocs.io/en/latest/).
+- Support [scikit-learn](https://scikit-learn.org/stable/api/index.html).
+- Support [scipy](https://docs.scipy.org/doc/scipy/reference/index.html).
+- Support [semver](https://python-semver.readthedocs.io/en/latest/).
+- Support [setuptools](https://setuptools.pypa.io/en/latest/).
+- Support [six](https://six.readthedocs.io/).
+- Support [sniffio](https://sniffio.readthedocs.io/en/latest/).
+- Support [sqlalchemy](https://docs.sqlalchemy.org/en/20/).
+- Support [tomlkit](https://tomlkit.readthedocs.io/en/latest/).
+- Support [torch](https://docs.pytorch.org/docs/stable/index.html).
+- Support [tox](https://tox.wiki/en/stable/).
+- Support [trio](https://trio.readthedocs.io/en/stable/).
+- Support [typing-extensions](https://typing-extensions.readthedocs.io/en/latest/).
+- Support [werkzeug](https://werkzeug.palletsprojects.com/en/stable/).
+- Support [wrapt](https://wrapt.readthedocs.io/en/master/).
+- Support [yarl](https://yarl.aio-libs.org/en/latest/).
+
+## v2025.4
+
+- Fix a bug in the crawler where relative paths aren't joined correctly.
+- Support [pandas](https://pandas.pydata.org/docs/reference/index.html).
+- Support [python-dateutil](https://dateutil.readthedocs.io/en/stable/).
+- Support [requests](https://requests.readthedocs.io/en/latest/).
+- Support [urllib3](https://urllib3.readthedocs.io/en/stable/reference/index.html).
+
+## v2025.3
+
+- Support [numpy](https://numpy.org/doc/stable/reference/index.html).
+
+## v2025.2
+
+- Added a new `pyrefdev-indexer` CLI to `crawl-docs` and `parse-docs`. The `mapping.py` is now reproducible and easily updatable when Python 3.14 is released.
+- Update the mappings.
+
+## v2025.1
+
+Initial release.

pyrefdev-2025.6/CLAUDE.md

@@ -0,0 +1,51 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Architecture
+
+The project has several components:
+
+1. **Web Server** (`src/pyrefdev/server.py`): FastAPI application that serves redirects based on symbol lookup. `index.html` is the landing page of the server
+2. **CLI Tool** (`src/pyrefdev/__main__.py`): Command-line interface that opens documentation in browser
+3. **Indexer** (`src/pyrefdev/indexer/`): Tools for crawling, parsing, and managing documentation mappings
+4. **Mapping System** (`src/pyrefdev/mapping/`): Individual Python files per package containing symbol-to-URL mappings
+
+## Common Commands
+
+### Development Setup
+```bash
+uv sync --all-extras --locked
+```
+
+### Testing
+```bash
+uv run pytest
+```
+
+### Run Web Server
+```bash
+uv run uvicorn pyrefdev.server:app --reload
+```
+
+### Run CLI Tool
+```bash
+pyrefdev <symbol>
+```
+
+### Indexer Operations
+```bash
+pyrefdev-indexer add-docs --docs-directory api-docs --package <package> --url <API reference doc root URL>
+pyrefdev-indexer crawl-docs --docs-directory api-docs --package <package>
+pyrefdev-indexer parse-docs --docs-directory api-docs --package <package>
+pyrefdev-indexer update-docs --docs-directory api-docs --package <package>
+pyrefdev-indexer update-landing-page
+```
+
+## Development Workflow
+
+- **Testing**: Run pytest to ensure mappings work correctly
+
+## Important Notes
+
+- Server deployment uses systemd and is configured in `pyrefdev.service`

{pyrefdev-2025.4 → pyrefdev-2025.6}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.4
 Name: pyrefdev
-Version: 2025.4
+Version: 2025.6
 Summary: The entry point to Python reference docs
-Project-URL: Home, https://pyref.dev
+Project-URL: Homepage, https://pyref.dev
 Project-URL: Source, https://github.com/mangoumbrella/pyref.dev
+Project-URL: Changelog, https://github.com/mangoumbrella/pyref.dev/blob/main/CHANGELOG.md
 Author-email: Mango Umbrella LLC <hi@mangoumbrella.com>
 License-Expression: Apache-2.0
 License-File: LICENSE
@@ -22,10 +23,12 @@ Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Free Threading
 Classifier: Topic :: Documentation
 Requires-Python: >=3.10
-Requires-Dist: yib>=0.2.0
+Requires-Dist: cyclopts>=3.19.0
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: packaging>=25.0
+Requires-Dist: yib>=0.3.0
 Provides-Extra: indexer
 Requires-Dist: beautifulsoup4>=4.13.4; extra == 'indexer'
-Requires-Dist: cyclopts>=3.19.0; extra == 'indexer'
 Requires-Dist: rich>=14.0.0; extra == 'indexer'
 Provides-Extra: server
 Requires-Dist: fastapi<1,>=0.115.12; extra == 'server'
@@ -52,10 +55,10 @@ Alternatively, you could also `pip install pyrefdev` and run the `pyrefdev` CLI
 
 ## Examples
 
-* https://pyref.dev/json
-* https://pyref.dev/pathlib.Path
-* https://pyref.dev/datetime.datetime.strftime
-* https://pyref.dev/numpy.array
+* [pyref.dev/json](https://pyref.dev/json)
+* [pyref.dev/pathlib.Path](https://pyref.dev/pathlib.Path)
+* [pyref.dev/datetime.datetime.strftime](https://pyref.dev/datetime.datetime.strftime)
+* [pyref.dev/numpy.array](https://pyref.dev/numpy.array)
 
 ## Supported packages
 
@@ -81,7 +84,7 @@ To update to a new version:
 ```bash
 > cd pyref.dev
 > git pull
-> uv sync --all-extras
+> uv sync --all-extras --locked
 > systemctl restart pyrefdev.service
 ```
 

{pyrefdev-2025.4 → pyrefdev-2025.6}/README.md

@@ -18,10 +18,10 @@ Alternatively, you could also `pip install pyrefdev` and run the `pyrefdev` CLI
 
 ## Examples
 
-* https://pyref.dev/json
-* https://pyref.dev/pathlib.Path
-* https://pyref.dev/datetime.datetime.strftime
-* https://pyref.dev/numpy.array
+* [pyref.dev/json](https://pyref.dev/json)
+* [pyref.dev/pathlib.Path](https://pyref.dev/pathlib.Path)
+* [pyref.dev/datetime.datetime.strftime](https://pyref.dev/datetime.datetime.strftime)
+* [pyref.dev/numpy.array](https://pyref.dev/numpy.array)
 
 ## Supported packages
 
@@ -47,7 +47,7 @@ To update to a new version:
 ```bash
 > cd pyref.dev
 > git pull
-> uv sync --all-extras
+> uv sync --all-extras --locked
 > systemctl restart pyrefdev.service
 ```
 

{pyrefdev-2025.4 → pyrefdev-2025.6}/pyproject.toml

@@ -30,13 +30,17 @@ keywords = [
 ]
 requires-python = ">=3.10"
 dependencies = [
-    "yib>=0.2.0",
+    "cyclopts>=3.19.0",
+    "jinja2>=3.1.6",
+    "packaging>=25.0",
+    "yib>=0.3.0",
 ]
 dynamic = ["version"]
 
 [project.urls]
-Home = "https://pyref.dev"
+Homepage = "https://pyref.dev"
 Source = "https://github.com/mangoumbrella/pyref.dev"
+Changelog = "https://github.com/mangoumbrella/pyref.dev/blob/main/CHANGELOG.md"
 
 [project.optional-dependencies]
 server = [
@@ -44,13 +48,12 @@ server = [
     "fastapi>=0.115.12,<1",
 ]
 indexer = [
-    "cyclopts>=3.19.0",
     "rich>=14.0.0",
     "Beautifulsoup4>=4.13.4",
 ]
 
 [project.scripts]
-pyrefdev = "pyrefdev.__main__:main"
+pyrefdev = "pyrefdev.__main__:app"
 pyrefdev-indexer = "pyrefdev.indexer.__main__:app"
 
 [tool.hatch.version]
@@ -65,4 +68,5 @@ version = "{version}"
 [dependency-groups]
 dev = [
     "pytest>=8.4.1",
+    "pre-commit>=4.2.0",
 ]

pyrefdev-2025.6/src/pyrefdev/__main__.py

@@ -0,0 +1,42 @@
+import webbrowser
+import sys
+from typing import Annotated
+
+import cyclopts
+from cyclopts import Parameter
+
+import pyrefdev
+from pyrefdev.mapping import MAPPING
+
+
+app = cyclopts.App("pyrefdev", help=pyrefdev.__doc__)
+
+
+@app.default
+def main(
+    symbol: str,
+    /,
+    *,
+    should_print: Annotated[
+        bool,
+        Parameter(
+            name=["--print", "-p"],
+            negative="--no-print",
+            help="When true, print the API reference URL instead of opening it in the browser.",
+        ),
+    ] = False,
+):
+    if not (url := MAPPING.get(symbol)):
+        url = MAPPING.get(symbol.lower())
+    if url:
+        if should_print:
+            print(url)
+        else:
+            webbrowser.open_new_tab(url)
+    else:
+        print(f"{symbol} not found", file=sys.stderr)
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    app()

pyrefdev-2025.6/src/pyrefdev/_version.py

@@ -0,0 +1 @@
+version = "2025.6"

pyrefdev-2025.6/src/pyrefdev/config.py

@@ -0,0 +1,134 @@
+import dataclasses
+
+from yib import yconsole
+
+
+console = yconsole.Console(stderr=True)
+
+
+@dataclasses.dataclass
+class Package:
+    pypi: str
+    # The crawler will crawl URLs with the same prefix until the last slash.
+    index_url: str
+    namespaces: list[str] = dataclasses.field(default_factory=list)
+    exclude_root_urls: list[str] = dataclasses.field(default_factory=list)
+
+    def __post_init__(self):
+        if not self.namespaces:
+            self.namespaces = [self.pypi.replace("-", "_")]
+
+    def is_cpython(self):
+        return self.pypi == "__python__"
+
+
+# fmt: off
+_packages = [
+    Package(
+        pypi="__python__",
+        index_url="https://docs.python.org/3/library",
+        exclude_root_urls=[
+            "https://docs.python.org/3/copyright.html",  # Conflict with built-in copyright.
+        ],
+    ),
+    Package(pypi="attrs", index_url="https://www.attrs.org/en/stable/", namespaces=["attrs", "attr"]),
+    Package(pypi="boto3", index_url="https://boto3.amazonaws.com/v1/documentation/api/latest/index.html", exclude_root_urls=["https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/"]),  # TODO: Support boto services
+    Package(pypi="botocore", index_url="https://botocore.amazonaws.com/v1/documentation/api/latest/index.html", exclude_root_urls=["https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/"]),  # TODO: Support boto services
+    Package(pypi="charset-normalizer", index_url="https://charset-normalizer.readthedocs.io/en/latest/"),
+    Package(pypi="cryptography", index_url="https://cryptography.io/en/latest/"),
+    Package(pypi="fsspec", index_url="https://filesystem-spec.readthedocs.io/en/latest/"),
+    Package(pypi="google-api-core", namespaces=["google.api_core"], index_url="https://googleapis.dev/python/google-api-core/latest/"),
+    Package(pypi="numpy", index_url="https://numpy.org/doc/stable/reference/index.html"),
+    Package(pypi="packaging", index_url="https://packaging.pypa.io/en/stable/"),
+    Package(pypi="pandas", index_url="https://pandas.pydata.org/docs/reference/index.html"),
+    Package(pypi="protobuf", index_url="https://googleapis.dev/python/protobuf/latest/",namespaces=["google.protobuf"]),
+    Package(pypi="pydantic-core", index_url="https://docs.pydantic.dev/latest/"),
+    Package(pypi="pydantic", index_url="https://docs.pydantic.dev/latest/"),
+    Package(pypi="python-dateutil", namespaces=["dateutil"], index_url="https://dateutil.readthedocs.io/en/stable/"),
+    Package(pypi="requests", index_url="https://requests.readthedocs.io/en/latest/"),
+    Package(pypi="s3fs", index_url="https://s3fs.readthedocs.io/en/latest/"),
+    Package(pypi="setuptools", index_url="https://setuptools.pypa.io/en/latest/"),
+    Package(pypi="six", index_url="https://six.readthedocs.io/"),
+    Package(pypi="typing-extensions", index_url="https://typing-extensions.readthedocs.io/en/latest/"),
+    Package(pypi="urllib3", index_url="https://urllib3.readthedocs.io/en/stable/reference/index.html"),
+    Package(pypi="platformdirs", index_url="https://platformdirs.readthedocs.io/en/latest/"),
+    Package(pypi="click", index_url="https://click.palletsprojects.com/en/stable/"),
+    Package(pypi="grpcio", index_url="https://grpc.github.io/grpc/python/index.html", namespaces=["grpc"]),
+    Package(pypi="jinja2", index_url="https://jinja.palletsprojects.com/en/latest/"),
+    Package(pypi="pyasn1", index_url="https://pyasn1.readthedocs.io/en/latest/contents.html"),
+    Package(pypi="h11", index_url="https://h11.readthedocs.io/en/latest/"),
+    Package(pypi="filelock", index_url="https://py-filelock.readthedocs.io/en/latest/"),
+    Package(pypi="aiohttp", index_url="https://docs.aiohttp.org/en/stable/"),
+    Package(pypi="cachetools", index_url="https://cachetools.readthedocs.io/en/latest/"),
+    Package(pypi="pluggy", index_url="https://pluggy.readthedocs.io/en/latest/"),
+    Package(pypi="markupsafe", index_url="https://markupsafe.palletsprojects.com/en/stable/"),
+    Package(pypi="scipy", index_url="https://docs.scipy.org/doc/scipy/reference/index.html"),
+    Package(pypi="propcache", index_url="https://propcache.aio-libs.org/en/latest/"),
+    Package(pypi="pathspec", index_url="https://python-path-specification.readthedocs.io/en/latest/index.html"),
+    Package(pypi="aiosignal", index_url="https://aiosignal.aio-libs.org/en/stable/"),
+    Package(pypi="pyOpenSSL", namespaces=["OpenSSL"], index_url="https://www.pyopenssl.org/en/latest/"),
+    Package(pypi="oauthlib", index_url="https://oauthlib.readthedocs.io/en/latest/"),
+    Package(pypi="requests-toolbelt", index_url="https://toolbelt.readthedocs.io/en/latest/index.html"),
+    Package(pypi="azure-identity", namespaces=["azure.identity"], index_url="https://azuresdkdocs.z19.web.core.windows.net/python/azure-identity/latest/index.html"),
+    Package(pypi="distlib", index_url="https://distlib.readthedocs.io/en/latest/"),
+    Package(pypi="pillow", namespaces=["PIL"], index_url="https://pillow.readthedocs.io/en/stable/"),
+    Package(pypi="frozenlist", index_url="https://frozenlist.aio-libs.org/en/latest/"),
+    Package(pypi="pyparsing", index_url="https://pyparsing-docs.readthedocs.io/en/latest/"),
+    Package(pypi="tomlkit", index_url="https://tomlkit.readthedocs.io/en/latest/"),
+    Package(pypi="rich", index_url="https://rich.readthedocs.io/en/latest/"),
+    Package(pypi="sqlalchemy", index_url="https://docs.sqlalchemy.org/en/20/"),
+    Package(pypi="requests-oauthlib", index_url="https://requests-oauthlib.readthedocs.io/en/latest/"),
+    Package(pypi="yarl", index_url="https://yarl.aio-libs.org/en/latest/"),
+    Package(pypi="multidict", index_url="https://multidict.aio-libs.org/en/stable/"),
+    Package(pypi="pyarrow", index_url="https://arrow.apache.org/docs/python/api.html"),
+    Package(pypi="sniffio", index_url="https://sniffio.readthedocs.io/en/latest/"),
+    Package(pypi="jsonschema", index_url="https://python-jsonschema.readthedocs.io/en/stable/"),
+    Package(pypi="google-auth", namespaces=["google.auth"], index_url="https://googleapis.dev/python/google-auth/latest/"),
+    Package(pypi="pyjwt", namespaces=["jwt"], index_url="https://pyjwt.readthedocs.io/en/stable/"),
+    Package(pypi="anyio", index_url="https://anyio.readthedocs.io/en/stable/"),
+    Package(pypi="psutil", index_url="https://psutil.readthedocs.io/en/latest/"),
+    Package(pypi="wrapt", index_url="https://wrapt.readthedocs.io/en/master/"),
+    Package(pypi="pygments", index_url="https://pygments.org/docs/api/"),
+    Package(pypi="rpds-py", namespaces=["rpds"], index_url="https://rpds.readthedocs.io/en/latest/"),
+    Package(pypi="pytest", index_url="https://docs.pytest.org/en/stable/reference/index.html"),
+    Package(pypi="libcst", index_url="https://libcst.readthedocs.io/en/latest/"),
+    Package(pypi="numba", index_url="https://numba.readthedocs.io/en/stable/reference/index.html"),
+    Package(pypi="trio", index_url="https://trio.readthedocs.io/en/stable/"),
+    Package(pypi="tox", index_url="https://tox.wiki/en/stable/"),
+    Package(pypi="h5py", index_url="https://docs.h5py.org/en/stable/"),
+    Package(pypi="cattrs", index_url="https://catt.rs/en/stable/"),
+    Package(pypi="nbformat", index_url="https://nbformat.readthedocs.io/en/latest/"),
+    Package(pypi="semver", index_url="https://python-semver.readthedocs.io/en/latest/"),
+    Package(pypi="aioitertools", index_url="https://aioitertools.omnilib.dev/en/stable/"),
+    Package(pypi="torch", index_url="https://docs.pytorch.org/docs/stable/index.html"),
+    Package(pypi="arrow", index_url="https://arrow.readthedocs.io/en/latest/"),
+    Package(pypi="apache-beam", index_url="https://beam.apache.org/releases/pydoc/current/"),
+    Package(pypi="fastapi", index_url="https://fastapi.tiangolo.com/reference/"),
+    Package(pypi="flask", index_url="https://flask.palletsprojects.com/en/stable/"),
+    Package(pypi="fastjsonschema", index_url="https://horejsek.github.io/python-fastjsonschema/"),
+    Package(pypi="jupyter-core", index_url="https://jupyter-core.readthedocs.io/en/latest/"),
+    Package(pypi="more-itertools", index_url="https://more-itertools.readthedocs.io/en/stable/"),
+    Package(pypi="werkzeug", index_url="https://werkzeug.palletsprojects.com/en/stable/"),
+    Package(pypi="scikit-learn", namespaces=["sklearn"], index_url="https://scikit-learn.org/stable/api/index.html"),
+    Package(pypi="coverage", index_url="https://coverage.readthedocs.io/en/latest/"),
+    Package(pypi="matplotlib", index_url="https://matplotlib.org/stable/api/index.html"),
+    Package(pypi="networkx", index_url="https://networkx.org/documentation/stable/reference/index.html"),
+    Package(pypi="ipython", index_url="https://ipython.readthedocs.io/en/stable/"),
+    Package(pypi="httplib2", index_url="https://httplib2.readthedocs.io/en/latest/"),
+    Package(pypi="cyclopts", index_url="https://cyclopts.readthedocs.io/en/latest/"),
+    Package(pypi="yib", index_url="https://yib.readthedocs.io/en/latest/"),
+    # ENTRY-LINE-MARKER
+]
+# fmt: on
+
+
+SUPPORTED_PACKAGES: dict[str, Package] = {pkg.pypi: pkg for pkg in _packages}
+
+
+def get_packages(package: str | None) -> list[Package]:
+    if package is None:
+        return list(SUPPORTED_PACKAGES.values())
+    else:
+        if package not in SUPPORTED_PACKAGES:
+            console.fatal(f"No package named {package}")
+        return [SUPPORTED_PACKAGES[package]]

{pyrefdev-2025.4 → pyrefdev-2025.6}/src/pyrefdev/indexer/__main__.py

@@ -5,6 +5,7 @@ from pyrefdev.indexer.add_docs import add_docs
 from pyrefdev.indexer.crawl_docs import crawl_docs
 from pyrefdev.indexer.parse_docs import parse_docs
 from pyrefdev.indexer.update_docs import update_docs
+from pyrefdev.indexer.update_landing_page import update_landing_page
 from pyrefdev.config import console
 
 
@@ -18,6 +19,7 @@ app.command(add_docs)
 app.command(crawl_docs)
 app.command(parse_docs)
 app.command(update_docs)
+app.command(update_landing_page)
 
 
 if __name__ == "__main__":

pyrefdev-2025.6/src/pyrefdev/indexer/add_docs.py

@@ -0,0 +1,44 @@
+import importlib
+from pathlib import Path
+import re
+
+from pyrefdev import config
+from pyrefdev.config import console
+from pyrefdev.indexer.update_docs import update_docs
+from pyrefdev.indexer.update_landing_page import update_landing_page_with_packages
+
+
+_MARKER = re.compile("(\n.*ENTRY-LINE-MARKER.*\n)")
+
+
+def add_docs(
+    *,
+    package: str,
+    docs_directory: Path | None = None,
+    url: str,
+    namespaces: list[str] | None = None,
+    crawl: bool = True,
+    num_threads_per_package: int | None = None,
+) -> None:
+    if package in config.SUPPORTED_PACKAGES:
+        console.fatal(f"Package exists: {package}")
+
+    if namespaces:
+        ns_content = ", ".join(f'"{ns}"' for ns in namespaces)
+        ns_str = f", namespaces=[{ns_content}]"
+    else:
+        ns_str = ""
+    config_entry = f'\n    Package(pypi="{package}"{ns_str}, index_url="{url}"),'
+    config_file = Path(config.__file__)
+    config_content = config_file.read_text()
+    config_content = _MARKER.sub(config_entry + r"\g<1>", config_content)
+    config_file.write_text(config_content)
+
+    if crawl:
+        importlib.reload(config)
+        update_docs(
+            docs_directory=docs_directory,
+            package=package,
+            num_threads_per_package=num_threads_per_package,
+        )
+        update_landing_page_with_packages(config.SUPPORTED_PACKAGES)