fastapi_swagger2 0.0.1__tar.gz

fastapi_swagger2-0.0.1/.gitignore

@@ -0,0 +1,163 @@
+# 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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+
+.DS_Store

fastapi_swagger2-0.0.1/.ruff_cache/.gitignore

@@ -0,0 +1 @@
+*

fastapi_swagger2-0.0.1/.ruff_cache/.update-informer

@@ -0,0 +1 @@
+v0.0.272

fastapi_swagger2-0.0.1/.ruff_cache/CACHEDIR.TAG

@@ -0,0 +1 @@
+Signature: 8a477f597d28d172789f06886806bc55

fastapi_swagger2-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Viraj Kanwade
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fastapi_swagger2-0.0.1/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.1
+Name: fastapi_swagger2
+Version: 0.0.1
+Summary: Swagger2 support for FastAPI framework
+Project-URL: Homepage, https://github.com/virajkanwade/fastapi_swagger2
+Project-URL: Documentation, https://github.com/virajkanwade/fastapi_swagger2
+Author-email: Viraj Kanwade <virajk.oib@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2023 Viraj Kanwade
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Classifier: Environment :: Web Environment
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: FastAPI
+Classifier: Framework :: Pydantic
+Classifier: Framework :: Pydantic :: 1
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+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
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Internet
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Requires-Dist: fastapi>=0.79.0
+Provides-Extra: all
+Requires-Dist: httpx>=0.23.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: ruff==0.0.272; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: black==23.3.0; extra == 'test'
+Requires-Dist: coverage[toml]<8.0,>=6.5.0; extra == 'test'
+Requires-Dist: httpx<0.24.0,>=0.23.0; extra == 'test'
+Requires-Dist: isort<6.0.0,>=5.0.6; extra == 'test'
+Requires-Dist: mypy==1.3.0; extra == 'test'
+Requires-Dist: pytest<8.0.0,>=7.1.3; extra == 'test'
+Requires-Dist: ruff==0.0.272; extra == 'test'
+Description-Content-Type: text/markdown
+
+# fastapi_swagger2
+<p align="center">
+Swagger2 support for FastAPI
+</p>
+<p align="center">
+<a href="https://pypi.org/project/fastapi_swagger2" target="_blank">
+    <img src="https://img.shields.io/pypi/v/fastapi_swagger2?color=%2334D058&label=pypi%20package" alt="Package version">
+</a>
+<a href="https://pypi.org/project/fastapi_swagger2" target="_blank">
+    <img src="https://img.shields.io/pypi/pyversions/fastapi_swagger2.svg?color=%2334D058" alt="Supported Python versions">
+</a>
+</p>
+
+---
+
+_Reason behind this library:_
+
+Few API GW services like Google Cloud API GW still support only Swagger 2.0 spec. Since FastAPI only supports OAS3, it is a challenge. Converting from OAS3 to Swagger 2.0 requires some manual steps which would hinder CI/CD.
+
+---
+
+## Requirements
+
+Python 3.8+
+
+FastAPI 0.79.0+
+
+## Installation
+
+<div class="termy">
+
+```console
+$ pip install fastapi_swagger2
+```
+
+</div>
+
+## Example
+
+```Python
+from typing import Union
+
+from fastapi import FastAPI
+from fastapi_swagger2 import FastAPISwagger2
+
+app = FastAPI()
+FastAPISwagger2(app)
+
+
+@app.get("/")
+def read_root():
+    return {"Hello": "World"}
+
+
+@app.get("/items/{item_id}")
+def read_item(item_id: int, q: Union[str, None] = None):
+    return {"item_id": item_id, "q": q}
+```
+
+This adds following endpoints:
+* http://localhost:8000/swagger2.json
+* http://localhost:8000/swagger2/docs
+* http://localhost:8000/swagger2/redoc
+
+## Development
+
+```console
+$ pip install "/path/to/fastapi_swagger2/repo[test,all]"
+```

fastapi_swagger2-0.0.1/README.md

@@ -0,0 +1,69 @@
+# fastapi_swagger2
+<p align="center">
+Swagger2 support for FastAPI
+</p>
+<p align="center">
+<a href="https://pypi.org/project/fastapi_swagger2" target="_blank">
+    <img src="https://img.shields.io/pypi/v/fastapi_swagger2?color=%2334D058&label=pypi%20package" alt="Package version">
+</a>
+<a href="https://pypi.org/project/fastapi_swagger2" target="_blank">
+    <img src="https://img.shields.io/pypi/pyversions/fastapi_swagger2.svg?color=%2334D058" alt="Supported Python versions">
+</a>
+</p>
+
+---
+
+_Reason behind this library:_
+
+Few API GW services like Google Cloud API GW still support only Swagger 2.0 spec. Since FastAPI only supports OAS3, it is a challenge. Converting from OAS3 to Swagger 2.0 requires some manual steps which would hinder CI/CD.
+
+---
+
+## Requirements
+
+Python 3.8+
+
+FastAPI 0.79.0+
+
+## Installation
+
+<div class="termy">
+
+```console
+$ pip install fastapi_swagger2
+```
+
+</div>
+
+## Example
+
+```Python
+from typing import Union
+
+from fastapi import FastAPI
+from fastapi_swagger2 import FastAPISwagger2
+
+app = FastAPI()
+FastAPISwagger2(app)
+
+
+@app.get("/")
+def read_root():
+    return {"Hello": "World"}
+
+
+@app.get("/items/{item_id}")
+def read_item(item_id: int, q: Union[str, None] = None):
+    return {"item_id": item_id, "q": q}
+```
+
+This adds following endpoints:
+* http://localhost:8000/swagger2.json
+* http://localhost:8000/swagger2/docs
+* http://localhost:8000/swagger2/redoc
+
+## Development
+
+```console
+$ pip install "/path/to/fastapi_swagger2/repo[test,all]"
+```

fastapi_swagger2-0.0.1/pyproject.toml

@@ -0,0 +1,95 @@
+[build-system]
+requires = ["hatchling", "flit_core >=3.2,<4"]
+build-backend = "hatchling.build"
+
+[project]
+name = "fastapi_swagger2"
+description = "Swagger2 support for FastAPI framework"
+readme = "README.md"
+requires-python = ">=3.8"
+license = { file="LICENSE" }
+authors = [
+    { name = "Viraj Kanwade", email = "virajk.oib@gmail.com" },
+]
+classifiers = [
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: System Administrators",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python",
+    "Topic :: Internet",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development",
+    "Typing :: Typed",
+    "Environment :: Web Environment",
+    "Framework :: AsyncIO",
+    "Framework :: FastAPI",
+    "Framework :: Pydantic",
+    "Framework :: Pydantic :: 1",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+    "Topic :: Internet :: WWW/HTTP",
+]
+dependencies = [
+    "fastapi>=0.79.0",
+]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/virajkanwade/fastapi_swagger2"
+Documentation = "https://github.com/virajkanwade/fastapi_swagger2"
+
+[project.optional-dependencies]
+test = [
+    "pytest >=7.1.3,<8.0.0",
+    "coverage[toml] >= 6.5.0,< 8.0",
+    "mypy ==1.3.0",
+    "ruff ==0.0.272",
+    "black == 23.3.0",
+    "isort >=5.0.6,<6.0.0",
+    "httpx >=0.23.0,<0.24.0",
+]
+dev = [
+    "ruff ==0.0.272",
+]
+all = [
+    "httpx >=0.23.0",
+]
+
+[tool.hatch.version]
+path = "src/fastapi_swagger2/__init__.py"
+
+[tool.isort]
+profile = "black"
+known_third_party = ["fastapi", "pydantic", "starlette"]
+
+[tool.mypy]
+strict = true
+
+[tool.ruff]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    # "I",  # isort
+    "C",  # flake8-comprehensions
+    "B",  # flake8-bugbear
+]
+ignore = [
+    "E501",  # line too long, handled by black
+    "B008",  # do not perform function calls in argument defaults
+    "C901",  # too complex
+]
+
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["F401"]
+
+[tool.ruff.isort]
+known-third-party = ["fastapi", "pydantic", "starlette"]

fastapi_swagger2-0.0.1/requirements-dev.txt

@@ -0,0 +1 @@
+-e .[dev,test,all]

fastapi_swagger2-0.0.1/requirements.txt

@@ -0,0 +1 @@
+-e .[all]

fastapi_swagger2-0.0.1/scripts/build.sh

@@ -0,0 +1,3 @@
+#!/bin/sh -e
+
+hatchling build

fastapi_swagger2-0.0.1/scripts/clean.sh

@@ -0,0 +1,8 @@
+#!/bin/sh -e
+
+if [ -d 'dist' ] ; then
+    rm -r dist
+fi
+if [ -d 'site' ] ; then
+    rm -r site
+fi

fastapi_swagger2-0.0.1/scripts/format.sh

@@ -0,0 +1,6 @@
+#!/bin/sh -e
+set -x
+
+ruff src/fastapi_swagger2 tests scripts --fix
+black src/fastapi_swagger2 tests scripts
+isort src/fastapi_swagger2 tests scripts

fastapi_swagger2-0.0.1/scripts/lint.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -e
+set -x
+
+mypy src/fastapi_swagger2
+ruff src/fastapi_swagger2 tests scripts
+black src/fastapi_swagger2 tests --check
+isort src/fastapi_swagger2 tests scripts --check-only

fastapi_swagger2-0.0.1/scripts/publish.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -e
+
+hatch publish

fastapi_swagger2-0.0.1/scripts/test.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -e
+set -x
+
+# # Check README.md is up to date
+# python ./scripts/docs.py verify-readme
+# export PYTHONPATH=./docs_src
+coverage run -m pytest tests ${@}