flask-openapi-scalar 1.43.8__tar.gz

flask_openapi_scalar-1.43.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

flask_openapi_scalar-1.43.8/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: flask-openapi-scalar
+Version: 1.43.8
+Summary: Provide Scalar UI for flask-openapi.
+Project-URL: Homepage, https://github.com/luolingchun/flask-openapi-plugins/tree/master/flask-openapi-scalar
+Project-URL: Documentation, https://luolingchun.github.io/flask-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: flask-openapi
+Description-Content-Type: text/markdown
+
+Provide Scalar UI for [flask-openapi](https://github.com/luolingchun/flask-openapi).

flask_openapi_scalar-1.43.8/flask_openapi_scalar/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2024/4/22 16:07

flask_openapi_scalar-1.43.8/flask_openapi_scalar/__version__.py

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

flask_openapi_scalar-1.43.8/flask_openapi_scalar/plugins.py

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2024/4/22 16:13
+import os
+
+from flask import Blueprint, render_template_string, current_app
+from flask_openapi.plugins import BasePlugin
+
+from .templates import scalar_html_string
+
+
+class RegisterPlugin(BasePlugin):
+    name = "scalar"
+    display_name = "Scalar"
+
+    @classmethod
+    def register(cls, doc_url: str) -> Blueprint:
+        _here = os.path.dirname(__file__)
+        template_folder = os.path.join(_here, "templates")
+        static_folder = os.path.join(template_folder, cls.name)
+        blueprint = Blueprint(
+            cls.name,
+            __name__,
+            template_folder=template_folder,
+            static_folder=static_folder
+        )
+
+        blueprint.add_url_rule(
+            rule=f"/{cls.name}",
+            endpoint=cls.name,
+            view_func=lambda: render_template_string(
+                current_app.config.get("SCALAR_HTML_STRING") or scalar_html_string,
+                doc_url=doc_url,
+                scalar_config=current_app.config.get("SCALAR_CONFIG")
+            )
+        )
+
+        return blueprint

flask_openapi_scalar-1.43.8/flask_openapi_scalar/templates/__init__.py

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2024/4/23 14:46
+scalar_html_string = """
+<!doctype html>
+<html>
+    <head>
+        <title>Scalar API</title>
+        <meta charset="utf-8" />
+        <meta
+        name="viewport"
+        content="width=device-width, initial-scale=1" />
+        <link rel="shortcut icon" href="scalar/images/scalar.svg">
+    </head>
+    <body>
+        <script
+        id="api-reference"
+        data-url="{{ doc_url }}">
+        </script>
+        <script>
+        const scalar_config = JSON.parse(`{{ scalar_config|default('{}')|tojson }}`);
+        var configuration = {...scalar_config};
+        var apiReference = document.getElementById('api-reference');
+        apiReference.dataset.configuration = JSON.stringify(configuration);
+        </script>
+        <script src="scalar/js/scalar.standalone.js"></script>
+    </body>
+</html>
+"""

flask_openapi_scalar-1.43.8/flask_openapi_scalar/templates/scalar/images/scalar.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 593 593">
+    <path fill="black" fill-rule="evenodd"
+        d="M347 0c6 0 12 5 12 12v134l94-95c5-5 13-5 17 0l72 72c4 4 5 12 0 16v1l-95 94h134c7 0 12 5 12 12v101c0 7-5 12-12 12H447l95 94c4 5 5 13 0 17l-72 72c-4 4-12 5-16 0h-1l-94-95v134c0 7-5 12-12 12H246c-7 0-12-5-12-12v-70c0-22 9-43 24-59l130-130c14-14 14-37 0-51L259 142a84 84 0 0 1-25-59V12c0-7 5-12 12-12h101ZM138 52h1l219 219c14 14 14 37 0 51L139 542c-4 5-12 5-17 0l-71-70c-4-5-5-12 0-17l95-96H12c-7 0-12-5-12-12V246c0-7 5-12 12-12h134l-95-94c-4-5-4-12 0-17l71-71c4-5 12-5 16 0Z" />
+</svg>