offapi 0.1.0__tar.gz → 0.1.2__tar.gz

{offapi-0.1.0 → offapi-0.1.2}/PKG-INFO

@@ -1,16 +1,18 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: offapi
-Version: 0.1.0
+Version: 0.1.2
 Summary: OpenAPI frontend render offline template.
 Author-Email: Keming <kemingy94@gmail.com>
-License: Apache-2.0
+License-Expression: Apache-2.0
 Classifier: Intended Audience :: Developers
 Project-URL: Homepage, https://github.com/kemingy/offapi
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 
 # OffAPI
 
+[![PyPI](https://img.shields.io/pypi/v/offapi.svg)](https://pypi.org/project/offapi/)
+
 OpenAPI template files for offline usage.
 
 This package will download the related files during the build time, and package them into the final distribution.
@@ -35,3 +37,9 @@ from offapi import OpenAPITemplate
 swagger_template = OpenAPITemplate.SWAGGER.value
 swagger_template.format(spec_url="your_path_to_the_spec.json")
 ```
+
+## Used by
+
+- [spectree](https://github.com/0b01001001/spectree): API spec validator and OpenAPI document generator for Python web frameworks.
+- [defspec](https://github.com/kemingy/defspec/): Create the OpenAPI spec and document from dataclass, attrs, etc.
+

{offapi-0.1.0 → offapi-0.1.2}/README.md

@@ -1,5 +1,7 @@
 # OffAPI
 
+[![PyPI](https://img.shields.io/pypi/v/offapi.svg)](https://pypi.org/project/offapi/)
+
 OpenAPI template files for offline usage.
 
 This package will download the related files during the build time, and package them into the final distribution.
@@ -24,3 +26,9 @@ from offapi import OpenAPITemplate
 swagger_template = OpenAPITemplate.SWAGGER.value
 swagger_template.format(spec_url="your_path_to_the_spec.json")
 ```
+
+## Used by
+
+- [spectree](https://github.com/0b01001001/spectree): API spec validator and OpenAPI document generator for Python web frameworks.
+- [defspec](https://github.com/kemingy/defspec/): Create the OpenAPI spec and document from dataclass, attrs, etc.
+

offapi-0.1.2/offapi/__init__.py

@@ -0,0 +1,42 @@
+import json
+from enum import Enum
+from importlib import resources
+from pathlib import PurePath
+
+from offapi.templates import ReDocTemplate, ScalarTemplate, SwaggerTemplate
+
+__all__ = ["OpenAPITemplate"]
+
+
+with (resources.files("offapi") / "url.json").open(encoding="utf-8") as f:
+    urls = json.load(f)
+
+
+def load_resource_file(filename: str) -> str:
+    content = (resources.files("offapi") / filename).read_text(encoding="utf-8")
+    # escape curly braces
+    return content.replace("{", "{{").replace("}", "}}")
+
+
+class OpenAPITemplate(Enum):
+    SWAGGER = SwaggerTemplate.safe_substitute(
+        {
+            PurePath(key).stem: load_resource_file(key)
+            for key in urls
+            if key.startswith("swagger")
+        }
+    )
+    REDOC = ReDocTemplate.safe_substitute(
+        {
+            PurePath(key).stem: load_resource_file(key)
+            for key in urls
+            if key.startswith("redoc")
+        }
+    )
+    SCALAR = ScalarTemplate.safe_substitute(
+        {
+            PurePath(key).stem: load_resource_file(key)
+            for key in urls
+            if key.startswith("scalar")
+        }
+    )

offapi-0.1.2/offapi/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.1.2"