Initial Commit

Author: KiraPC

.gitignore

@@ -0,0 +1,15 @@
+/build/*
+/dist/*
+/swagger_confluence_pub.egg-info/*
+/venv/*
+**/.DS_Store
+**/*.pyc
+.vscode/*
+/.eggs/*
+/docs/build/*
+/test-reports/*
+/_build/*
+/_static/*
+/_templates/*
+/__pycache__/*
+/*.egg-info/

LICENSE.txt

@@ -0,0 +1,17 @@
+MIT License
+Copyright (c) 2018 YOUR NAME
+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.

README.md

@@ -0,0 +1,17 @@
+### What this repository contains
+
+A Command Line Interface to save openapi file from a FastAPI application
+
+### Installation: 
+
+install the package
+```
+pip install fastapi-openapi-generator
+```
+
+### How to use
+```
+fastapi-openapi-gen main:app \
+    --app-dir= # The path to mounth in the python path to import the module \
+    --output-dir= # The path where store the openapi template
+```

generator/__init__.py

@@ -0,0 +1,2 @@
+class NotFastAPIException(Exception):
+    pass

generator/lib/__init__.py

@@ -0,0 +1,37 @@
+import sys
+import json
+import click
+from fastapi import FastAPI
+from uvicorn.importer import import_from_string
+from generator.lib.exceptions import NotFastAPIException
+
+@click.command()
+@click.argument("app")
+@click.option(
+    "--app-dir",
+    "app_dir",
+    default=".",
+    show_default=True,
+    help="Look for APP in the specified directory, by adding this to the PYTHONPATH."
+    " Defaults to the current working directory."
+)
+@click.option(
+    "--output-dir",
+    "output_dir",
+    default=".",
+    show_default=True,
+    help="The folder where the swagger is stored."
+)
+def main(app, app_dir, output_dir):
+    sys.path.insert(0, app_dir)
+
+    fastapi: FastAPI = import_from_string(app)
+
+    if not isinstance(fastapi, FastAPI):
+        raise NotFastAPIException('The given object is not a FastAPI application')
+
+    with open('{}/openapi.json'.format(output_dir), 'w+') as openapi:
+        openapi.write(json.dumps(fastapi.openapi(), indent=2))
+
+if __name__ == "__main__":
+    main()

generator/lib/exceptions.py

@@ -0,0 +1,3 @@
+click==7.1.2
+uvicorn==0.13.3
+fastapi==0.63.0

generator/main.py

@@ -0,0 +1,38 @@
+# pylint: disable=line-too-long
+"""
+    :author: Pasquale Carmone Carbone
+
+    Setup module
+"""
+import setuptools
+
+with open("README.md", "r") as fh:
+    LONG_DESCRIPTION = fh.read()
+
+with open('requirements.txt', 'r') as fin:
+    REQS = fin.read().splitlines()
+
+setuptools.setup(
+    setup_requires=['setuptools-git-version'],
+    version_format='{tag}',
+    name="fastapi-openapi-generator",
+    author="Pasquale Carmine Carbone",
+    author_email="[email protected]",
+    description="A Command Line Interface to save openapi file from a FastAPI application",
+    long_description=LONG_DESCRIPTION,
+    url="https://github.com/KiraPC/fastapi-openapi-generator",
+    long_description_content_type="text/markdown",
+    packages=setuptools.find_packages(exclude=['venv', 'fastapi-openapi-generator.egg-info', 'build']),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    entry_points={
+        'console_scripts': [
+            'fastapi-openapi-gen = generator.main:main'
+        ]
+    },
+    python_requires='>=3.0',
+    install_requires=REQS
+)