Add "disable" option to skip requests recording

Author: JamalZeynalov

README.md

@@ -37,6 +37,8 @@ pip install swagger-coverage
 API_DOCS_TYPE="swagger"  # Note: "openapi" is default type of API docs
 API_DOCS_VERSION="2.0"  # Note: "3.0.0" is default version of API docs
 API_DOCS_FORMAT="yaml"  # Note: "json" is default format of API docs and output files
+IS_DISABLED=True  # Skip requests recording. No files will be saved to 'swagger-coverage-output' dir 
+
 ```
 
 ### 3. Add the session-scoped fixture

requirements.txt

@@ -1,6 +1,7 @@
-requests>=2.27.1
-Faker==13.3.3
-setuptools==61.0.0
+requests==2.28.1
+Faker==14.1.0
+setuptools==65.2.0
 PyYAML~=6.0
-python-dotenv==0.20.0
-rootpath~=0.1.1
+python-dotenv~=0.20.0
+rootpath~=0.1.1
+environs==9.5.0

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name="swagger-coverage",
-    version="2.2.4",
+    version="2.2.5",
     author="Jamal Zeinalov",
     author_email="jamal.zeynalov@gmail.com",
     description='Python adapter for "swagger-coverage" tool',
@@ -19,12 +19,13 @@
         "Operating System :: OS Independent",
     ],
     install_requires=[
-        "requests>=2.25.1",
-        "Faker>=6.0.0",
-        "setuptools>=53.0.0",
-        "PyYAML",
-        "python-dotenv~=0.16.0",
+        "requests~=2.27.1",
+        "Faker~=14.1.0",
+        "setuptools~=65.2.0",
+        "PyYAML~=6.0",
+        "python-dotenv~=0.20.0",
         "rootpath~=0.1.1",
+        "environs~=9.5.0",
 
     ],
     python_requires=">=3.6",

swagger_coverage_py/configs.py

@@ -1,10 +1,12 @@
-import os
+from environs import Env
 
 import rootpath
 from dotenv import load_dotenv
 
 load_dotenv(f"{rootpath.detect()}/.env")
+env = Env()
 
-API_DOCS_TYPE = os.environ.get("API_DOCS_TYPE", "openapi")  # "swagger"
-API_DOCS_VERSION = os.environ.get("API_DOCS_VERSION", "3.0.0")  # "2.0"
-API_DOCS_FORMAT = os.environ.get("API_DOCS_FORMAT", "json")  # "yaml"
+API_DOCS_TYPE = env.st("API_DOCS_TYPE", default="openapi")  # "swagger"
+API_DOCS_VERSION = env.st("API_DOCS_VERSION", default="3.0.0")  # "2.0"
+API_DOCS_FORMAT = env.str("API_DOCS_FORMAT", default="json")  # "yaml"
+IS_DISABLED = env.bool("API_COVERAGE_REPORTS_DISABLED", default=False)  # If True then requests won't be recorded

swagger_coverage_py/listener.py

@@ -1,5 +1,6 @@
 import requests
 
+from swagger_coverage_py.configs import IS_DISABLED
 from swagger_coverage_py.request_schema_handler import RequestSchemaHandler
 from swagger_coverage_py.uri import URI
 
@@ -21,4 +22,5 @@ def __init__(
         self.__uri = URI(base_url, raw_path, **uri_params)
         self.response = requests.request(method, self.__uri.full, **kwargs)
 
-        RequestSchemaHandler(self.__uri, method, self.response, kwargs).write_schema()
+        if not IS_DISABLED:
+            RequestSchemaHandler(self.__uri, method, self.response, kwargs).write_schema()