star-openapi-rapidoc 9.3.8__tar.gz

star_openapi_rapidoc-9.3.8/.gitignore

@@ -0,0 +1,141 @@
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+.idea

star_openapi_rapidoc-9.3.8/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: star-openapi-rapidoc
+Version: 9.3.8
+Summary: Provide RapiDoc UI for star-openapi.
+Project-URL: Homepage, https://github.com/luolingchun/star-openapi-plugins/tree/master/star-openapi-rapidoc
+Project-URL: Documentation, https://luolingchun.github.io/star-openapi/latest/Usage/UI_Templates/
+Maintainer-email: llc <luolingchun@outlook.com>
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.8
+Requires-Dist: star-openapi
+Description-Content-Type: text/markdown
+
+Provide RapiDoc UI for [star-openapi](https://github.com/luolingchun/star-openapi).

star_openapi_rapidoc-9.3.8/pyproject.toml

@@ -0,0 +1,45 @@
+[project]
+name = "star-openapi-rapidoc"
+description = "Provide RapiDoc UI for star-openapi."
+readme = { text = "Provide RapiDoc UI for [star-openapi](https://github.com/luolingchun/star-openapi).", content-type = "text/markdown" }
+license = { text = "MIT" }
+maintainers = [{ name = "llc", email = "luolingchun@outlook.com" }]
+classifiers = [
+    # "Development Status :: 1 - Planning",
+    # "Development Status :: 2 - Pre-Alpha",
+    # "Development Status :: 3 - Alpha",
+    # "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
+    # "Development Status :: 6 - Mature",
+    # "Development Status :: 7 - Inactive",
+    "Environment :: Web Environment",
+    "Framework :: Flask",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only"
+]
+requires-python = ">=3.8"
+dependencies = ["star-openapi"]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/luolingchun/star-openapi-plugins/tree/master/star-openapi-rapidoc"
+Documentation = "https://luolingchun.github.io/star-openapi/latest/Usage/UI_Templates/"
+
+[project.entry-points."star_openapi.plugins"]
+register = "star_openapi_rapidoc.plugins.RegisterPlugin"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "star_openapi_rapidoc/__version__.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/star_openapi_rapidoc"
+]

star_openapi_rapidoc-9.3.8/star_openapi_rapidoc/__version__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+__version__ = "9.3.8"

star_openapi_rapidoc-9.3.8/star_openapi_rapidoc/plugins.py

@@ -0,0 +1,41 @@
+import os.path
+
+from jinja2 import Template
+from star_openapi.plugins import BasePlugin
+from starlette.responses import HTMLResponse
+from starlette.routing import Route, Mount
+from starlette.staticfiles import StaticFiles
+
+from .templates import rapidoc_html_string
+
+
+class RegisterPlugin(BasePlugin):
+    def __init__(self):
+        self.name = "rapidoc"
+        self.display_name = "RapiDoc"
+        self.doc_url = "/openapi.json"
+
+    def rapidoc_endpoint(self, request):
+        template = Template(request.app.config.get("RAPIDOC_HTML_STRING") or rapidoc_html_string)
+        return HTMLResponse(
+            content=template.render(
+                {
+                    "doc_url": self.doc_url,
+                    "rapidoc_config": request.app.config.get("RAPIDOC_CONFIG")
+                }
+            )
+        )
+
+    def register(self, doc_url: str) -> list[Route]:
+        self.doc_url = doc_url
+        static_folder = os.path.join(os.path.dirname(__file__), "templates", "rapidoc")
+
+        routes = [
+            Route(
+                f"/{self.name}",
+                endpoint=self.rapidoc_endpoint
+            ),
+            Mount("/rapidoc", app=StaticFiles(directory=static_folder), name="static"),
+        ]
+
+        return routes

star_openapi_rapidoc-9.3.8/star_openapi_rapidoc/templates/__init__.py

@@ -0,0 +1,24 @@
+rapidoc_html_string = """
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1,user-scalable=yes">
+    <title>RapiDoc</title>
+    <link rel="shortcut icon" href="rapidoc/images/rapidoc.svg">
+</head>
+<body>
+<rapi-doc spec-url='{{ doc_url }}'></rapi-doc>
+<script>
+    const rapidoc_config = JSON.parse(`{{ rapidoc_config|default('{}')|tojson }}`);
+    var rapiDoc = document.querySelector("rapi-doc");
+    var specUrl = new URL("{{ doc_url }}", window.location.href).href;
+    rapiDoc.setAttribute("spec-url", specUrl);
+    for(var k in rapidoc_config) {
+        rapiDoc.setAttribute(k, rapidoc_config[k]);
+    }
+</script>
+<script src="rapidoc/js/rapidoc-min.js"></script>
+</body>
+</html>
+"""

star_openapi_rapidoc-9.3.8/star_openapi_rapidoc/templates/rapidoc/images/rapidoc.svg

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="64px" height="64px" viewBox="0 0 64 64" version="1.1">
+<g id="surface1">
+<path style=" stroke:none;fill-rule:nonzero;fill:rgb(67.843137%,75.686275%,39.607843%);fill-opacity:1;" d="M 43.875 51.375 C 39.367188 59.195312 31.027344 64.011719 22 64.011719 C 12.972656 64.011719 4.632812 59.195312 0.125 51.375 C 4.359375 44.203125 11.84375 39.566406 20.152344 38.96875 C 28.457031 38.367188 36.53125 41.882812 41.75 48.375 C 42.53125 49.324219 43.238281 50.324219 43.875 51.375 Z M 43.875 51.375 "/>
+<path style=" stroke:none;fill-rule:nonzero;fill:rgb(60%,66.666667%,32.156863%);fill-opacity:1;" d="M 41.75 48.375 C 31.832031 51.300781 21.136719 47.882812 14.75 39.75 C 24.667969 36.824219 35.363281 40.242188 41.75 48.375 Z M 51.5 52.375 L 10.625 52.375 C 10.074219 52.375 9.625 51.925781 9.625 51.375 C 9.625 50.824219 10.074219 50.375 10.625 50.375 L 51.5 50.375 C 52.003906 50.4375 52.378906 50.867188 52.375 51.375 C 52.378906 51.882812 52.003906 52.3125 51.5 52.375 Z M 51.5 52.375 "/>
+<path style=" stroke:none;fill-rule:nonzero;fill:rgb(100%,78.039216%,23.137255%);fill-opacity:1;" d="M 46.75 42.25 L 46.125 46 C 37.382812 48.382812 28.039062 45.898438 21.632812 39.492188 C 15.226562 33.085938 12.742188 23.742188 15.125 15 C 23.1875 12.902344 31.769531 14.894531 38.082031 20.332031 C 44.394531 25.773438 47.632812 33.964844 46.75 42.25 Z M 46.75 42.25 "/>
+<path style=" stroke:none;fill-rule:nonzero;fill:rgb(93.72549%,69.019608%,14.509804%);fill-opacity:1;" d="M 46.75 42.25 C 38.066406 37.25 33.160156 27.585938 34.25 17.625 C 42.910156 22.648438 47.804688 32.292969 46.75 42.25 Z M 51.5 52.375 L 50.75 52.125 L 21.875 23.25 C 21.632812 22.855469 21.695312 22.347656 22.019531 22.019531 C 22.347656 21.695312 22.855469 21.632812 23.25 21.875 L 52.125 50.625 C 52.433594 50.894531 52.542969 51.328125 52.40625 51.710938 C 52.269531 52.097656 51.910156 52.359375 51.5 52.375 Z M 51.5 52.375 "/>
+<path style=" stroke:none;fill-rule:nonzero;fill:rgb(100%,56.470588%,24.313725%);fill-opacity:1;" d="M 38.875 21.875 C 38.875 31.25 43.875 39.375 51.5 43.75 C 59.320312 39.242188 64.136719 30.902344 64.136719 21.875 C 64.136719 12.847656 59.320312 4.507812 51.5 0 C 43.683594 4.511719 38.871094 12.851562 38.875 21.875 Z M 38.875 21.875 "/>
+<path style=" stroke:none;fill-rule:nonzero;fill:rgb(90.980392%,45.490196%,14.509804%);fill-opacity:1;" d="M 51.5 52.375 C 50.949219 52.375 50.5 51.925781 50.5 51.375 L 50.5 10.625 C 50.644531 10.234375 51.019531 9.972656 51.4375 9.972656 C 51.855469 9.972656 52.230469 10.234375 52.375 10.625 L 52.375 51.375 C 52.378906 51.882812 52.003906 52.3125 51.5 52.375 Z M 51.5 52.375 "/>
+</g>
+</svg>