fastapi2postman 0.1.0__tar.gz → 0.1.1__tar.gz

{fastapi2postman-0.1.0 → fastapi2postman-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastapi2postman
-Version: 0.1.0
+Version: 0.1.1
 Summary: FastAPI APIs to Postman collections
 Home-page: https://github.com/ashhadahsan/fastapi2postman
 Author: Ashhad Ahsan Rehman

fastapi2postman-0.1.1/README.rst

@@ -0,0 +1,74 @@
+.. _Postman: https://www.postman.com/
+.. _FastAPI: https://fastapi.tiangolo.com/
+
+.. _flask2postman: https://github.com/numberly/flask2postman/
+=============
+fastapi2postman
+=============
+
+.. image:: https://img.shields.io/pypi/v/flask2postman.svg
+   :target: https://pypi.org/project/fastapi2postman
+.. image:: https://img.shields.io/github/license/numberly/flask2postman.svg
+   :target: https://github.com/ashhadahsan/fastapi2postman/blob/main/LICENSE
+
+|
+
+A tool that creates a Postman_ collection from a FastAPI_ application.
+
+Inspired from flask2postman_
+
+
+Install
+=======
+
+.. code-block:: sh
+
+    $ pip install fastapi2postman
+
+
+Example
+=======
+
+Let's say that you have a FastAPI project called "app.py"  and you want to generate a Postman collection out of it.
+
+You just need to tell :code:`fastapi2postman` 
+
+.. code-block:: sh
+
+    $ fastapi2postman --app app.py 
+
+If you want to change the name of the output file use --output flag, the default name is ofcousre output.json
+
+.. code-block:: sh
+
+    $ fastapi2postman --app app.py --output output.json
+
+This will generate the JSON configuration, and write it into the
+:code:`output.json` file. You can then import this file into Postman ("Import
+Collection" button), and profit:
+
+On a side note, you can see that endpoint's docstrings are automatically
+imported as descriptions.
+
+
+Usage
+=====
+
+.. code-block:: sh
+
+    usage: fastapi2postman [-h] [--output OUTPUT] [--name NAME] [--host HOST]
+                       [--port PORT] --app APP
+
+optional arguments:
+  -h, --help       show this help message and exit
+  --output OUTPUT  Output file
+  --name NAME      Collection name
+  --host HOST      API host
+  --port PORT      API port
+  --app APP        Path to FastAPI application instance
+
+
+License
+=======
+
+MIT

{fastapi2postman-0.1.0 → fastapi2postman-0.1.1}/fastapi2postman.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastapi2postman
-Version: 0.1.0
+Version: 0.1.1
 Summary: FastAPI APIs to Postman collections
 Home-page: https://github.com/ashhadahsan/fastapi2postman
 Author: Ashhad Ahsan Rehman

{fastapi2postman-0.1.0 → fastapi2postman-0.1.1}/fastapi2postman.egg-info/SOURCES.txt

@@ -1,5 +1,5 @@
 LICENSE
-README.md
+README.rst
 fastapi2postman.py
 setup.py
 fastapi2postman.egg-info/PKG-INFO

{fastapi2postman-0.1.0 → fastapi2postman-0.1.1}/fastapi2postman.py

@@ -65,7 +65,7 @@ def main():
         collection["item"].append(item)
 
     with open(args.output, "w") as f:
-        json.dump(collection, f)
+        json.dump(collection, f, indent=4)
 
 
 if __name__ == "__main__":

{fastapi2postman-0.1.0 → fastapi2postman-0.1.1}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="fastapi2postman",
-    version="0.1.0",
+    version="0.1.1",
     description="FastAPI APIs to Postman collections",
     author="Ashhad Ahsan Rehman",
     license="MIT",

fastapi2postman-0.1.0/README.md

@@ -1,2 +0,0 @@
-# fastapi2postman
- fastapi2postman