rapidoc 0.1.0__py3-none-any.whl

rapidoc/__init__.py

@@ -0,0 +1,41 @@
+"""RapiDoc for Python web frameworks.
+
+    from fastapi import FastAPI
+    from rapidoc.fastapi import setup_rapidoc
+
+    app = FastAPI(docs_url=None, redoc_url=None)
+    setup_rapidoc(app)          # the reference at /docs, reading the app's /openapi.json
+
+``rapidoc.contract`` is the RapiDoc integration contract in Python (a port of ``@rapidoc/embed``): the page,
+the routes and the attributes. A framework module (``rapidoc.fastapi``, ``rapidoc.starlette``) only maps
+them to that framework's routes. This module imports no framework.
+"""
+
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from typing import Any
+
+from . import contract
+
+__all__ = ["rapidoc_version", "rapidoc_manifest", "contract", "ASSETS"]
+
+#: One rapidoc release: the bundle, its license file and integration.json
+ASSETS = Path(__file__).parent / "assets"
+
+
+def rapidoc_manifest() -> dict[str, Any]:
+    """``integration.json`` of the rapidoc release this package ships: version, files, SRI hashes."""
+    file = ASSETS / "integration.json"
+    if not file.exists():
+        raise RuntimeError(
+            "rapidoc: the rapidoc bundle is missing from this installation "
+            "(in a source checkout, run scripts/sync_assets.py)"
+        )
+    return json.loads(file.read_text(encoding="utf-8"))
+
+
+def rapidoc_version() -> str:
+    """The version of rapidoc this package serves."""
+    return rapidoc_manifest()["version"]

rapidoc/assets/integration.json

@@ -0,0 +1,43 @@
+{
+  "contract": 1,
+  "name": "rapidoc",
+  "version": "12.2.0",
+  "elements": [
+    "rapi-doc",
+    "rapi-doc-mini",
+    "oauth-receiver"
+  ],
+  "cdn": "https://cdn.jsdelivr.net/npm/rapidoc@12.2.0/dist/",
+  "files": {
+    "rapidoc-min.js": {
+      "role": "script",
+      "contentType": "text/javascript; charset=utf-8",
+      "bytes": 643136,
+      "integrity": "sha384-1JA7hsG9FwOzHQnEH+aOO9WV+k74Ft3W1rjU1P7E4RtAXHaVqDP8sa49oGLhuzHD"
+    },
+    "rapidoc-min.js.LICENSE.txt": {
+      "role": "license",
+      "contentType": "text/plain; charset=utf-8",
+      "bytes": 19073,
+      "integrity": "sha384-f2/nGiQja338BGgbRRM9Qb++auJfKpfflao4DEGOVuXc+Y2ORfDs1MugRjYeLXbu"
+    },
+    "oauth-receiver.html": {
+      "role": "oauth-receiver",
+      "contentType": "text/html; charset=utf-8",
+      "bytes": 236,
+      "integrity": "sha384-rfos5ZPmmjObE/xd+YkxUxo2Pj7jgdyLD4FaC9OiacqFZIh53ENId1EYcXyOCcLW"
+    },
+    "rapidoc-flow-min.js": {
+      "role": "flow-script",
+      "contentType": "text/javascript; charset=utf-8",
+      "bytes": 213829,
+      "integrity": "sha384-asDo0SV5f87CcYYk9KjQKpLggdr8OBXYrd/8TV2MvLF/YHGYG9K/9n0OYJUSn/5P"
+    },
+    "rapidoc-flow-min.js.LICENSE.txt": {
+      "role": "flow-license",
+      "contentType": "text/plain; charset=utf-8",
+      "bytes": 8286,
+      "integrity": "sha384-oaDE7s/9ktovzg47bUf0BY+Ksq+YFB84dQKb+WJbfNfk3E7Nd/PUx2RlQZwUS25W"
+    }
+  }
+}