pytest-api-cov 1.0.0__tar.gz → 1.0.2__tar.gz

{pytest_api_cov-1.0.0 → pytest_api_cov-1.0.2}/PKG-INFO

@@ -1,19 +1,19 @@
 Metadata-Version: 2.4
 Name: pytest-api-cov
-Version: 1.0.0
-Summary: Api Coverage Report Pytest Plugin
+Version: 1.0.2
+Summary: Pytest Plugin to provide API Coverage statistics for Python Web Frameworks
 Author-email: Barnaby Gill <barnabasgill@gmail.com>
 License: Apache-2.0
 License-File: LICENSE
 Requires-Python: >=3.10
-Requires-Dist: fastapi>=0.116.1
-Requires-Dist: flask>=3.1.1
-Requires-Dist: httpx>=0.28.1
-Requires-Dist: pydantic>=2.11.7
-Requires-Dist: pytest>=8.4.1
-Requires-Dist: rich>=14.0.0
-Requires-Dist: starlette>=0.47.1
-Requires-Dist: tomli>=2.2.1
+Requires-Dist: fastapi>=0.68.0
+Requires-Dist: flask>=2.0.0
+Requires-Dist: httpx>=0.20.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pytest>=6.0.0
+Requires-Dist: rich>=10.0.0
+Requires-Dist: starlette>=0.14.0
+Requires-Dist: tomli>=1.2.0
 Description-Content-Type: text/markdown
 
 # pytest-api-cov
@@ -44,11 +44,28 @@ For most projects, no configuration is needed:
 pytest --api-cov-report
 ```
 
+### App Location Flexibility
+
+**Zero Config**: Works automatically if your app is in `app.py`, `main.py`, or `server.py`
+
+**Any Location**: Place your app anywhere in your project - just create a `conftest.py`:
+
+```python
+import pytest
+from my_project.backend.api import my_app  # Any import path!
+
+@pytest.fixture
+def app():
+    return my_app
+```
+
 The plugin will automatically discover your Flask/FastAPI app if it's in common locations:
 - `app.py` (with variable `app`, `application`, or `main`)
 - `main.py` (with variable `app`, `application`, or `main`) 
 - `server.py` (with variable `app`, `application`, or `server`)
 
+**Your app can be located anywhere!** If it's not in a standard location, just create a `conftest.py` file to tell the plugin where to find it.
+
 ### Example
 
 Given this FastAPI app in `app.py`:
@@ -74,12 +91,12 @@ def health_check():
 And this test file:
 
 ```python
-def test_root_endpoint(client):
-    response = client.get("/")
+def test_root_endpoint(coverage_client):
+    response = coverage_client.get("/")
     assert response.status_code == 200
 
-def test_get_user(client):
-    response = client.get("/users/123")
+def test_get_user(coverage_client):
+    response = coverage_client.get("/users/123")
     assert response.status_code == 200
 ```
 
@@ -93,6 +110,22 @@ Uncovered Endpoints:
 Total API Coverage: 66.67%
 ```
 
+Or running with advanced options `pytest --api-cov-report --api-cov-show-covered-endpoints --api-cov-exclusion-patterns="/users/*" --api-cov-show-excluded-endpoints --api-cov-report-path=api_coverage.json --api-cov-fail-under=49` produces:
+
+```
+API Coverage Report
+Uncovered Endpoints:
+  [X] /health
+Covered Endpoints:
+  [.] /
+Excluded Endpoints:
+  [-] /users/{user_id}
+
+SUCCESS: Coverage of 50.0% meets requirement of 49.0%
+
+JSON report saved to api_coverage.json
+```
+
 ## Advanced Configuration
 
 ### Setup Wizard
@@ -110,15 +143,56 @@ This will:
 
 ### Manual Configuration
 
-Create a `conftest.py` file:
+Create a `conftest.py` file to specify your app location (works with **any** file path or structure):
 
 ```python
 import pytest
-from your_app import app
+
+# Import from anywhere in your project
+from my_project.backend.api import flask_app
+# or from src.services.web_server import fastapi_instance  
+# or from deeply.nested.modules import my_app
 
 @pytest.fixture
 def app():
-    return app
+    return flask_app  # Return your app instance
+```
+
+This approach works with any project structure - the plugin doesn't care where your app is located as long as you can import it.
+
+### Custom Test Client Fixtures
+
+If you have an existing test client fixture with custom setup (authentication, headers, etc.), you can wrap it with coverage tracking:
+
+```python
+import pytest
+from fastapi.testclient import TestClient
+from your_app import app
+
+@pytest.fixture
+def my_custom_client():
+    """Custom test client with authentication."""
+    client = TestClient(app)
+    client.headers.update({"Authorization": "Bearer test-token"})
+    return client
+
+def test_endpoint(coverage_client):
+    # coverage_client will be your custom client with coverage tracking
+    response = coverage_client.get("/protected-endpoint")
+    assert response.status_code == 200
+```
+
+Configure it in `pyproject.toml`:
+
+```toml
+[tool.pytest_api_cov]
+client_fixture_name = "my_custom_client"
+```
+
+Or via command line:
+
+```bash
+pytest --api-cov-report --api-cov-client-fixture-name=my_custom_client
 ```
 
 ### Configuration Options
@@ -153,6 +227,9 @@ force_sugar = true
 
 # Force no Unicode symbols in output
 force_sugar_disabled = true
+
+# Wrap an existing custom test client fixture with coverage tracking
+client_fixture_name = "my_custom_client"
 ```
 
 ### Command Line Options
@@ -194,7 +271,6 @@ Works automatically with FastAPI and Flask applications.
 
 ```python
 from fastapi import FastAPI
-from fastapi.testclient import TestClient
 
 app = FastAPI()
 
@@ -202,9 +278,9 @@ app = FastAPI()
 def read_item(item_id: int):
     return {"item_id": item_id}
 
-# Tests automatically get a 'client' fixture
-def test_read_item(client):
-    response = client.get("/items/42")
+# Tests automatically get a 'coverage_client' fixture
+def test_read_item(coverage_client):
+    response = coverage_client.get("/items/42")
     assert response.status_code == 200
 ```
 
@@ -219,9 +295,9 @@ app = Flask(__name__)
 def get_user(user_id):
     return {"user_id": user_id}
 
-# Tests automatically get a 'client' fixture  
-def test_get_user(client):
-    response = client.get("/users/123")
+# Tests automatically get a 'coverage_client' fixture  
+def test_get_user(coverage_client):
+    response = coverage_client.get("/users/123")
     assert response.status_code == 200
 ```
 
@@ -301,13 +377,56 @@ jobs:
 
 ### No App Found
 
-If you see "No API app found", ensure:
+If you see "No API app found", you have several options:
+
+**Option 1 - Auto-discovery (Zero Config)**
+Place your app in a standard location with a standard name:
+- Files: `app.py`, `main.py`, `server.py`, `wsgi.py`, `asgi.py`
+- Variable names: `app`, `application`, `main`, `server`
+
+**Option 2 - Custom Location (Any File/Path)**
+Create a `conftest.py` file to specify your app location:
+
+```python
+import pytest
+from my_project.api.server import my_flask_app  # Any import path
+# or from src.backend.main import fastapi_instance
+# or from anywhere import your_app
+
+@pytest.fixture
+def app():
+    return my_flask_app  # Return your app instance
+```
+
+**Option 3 - Override Auto-discovery**
+If you have multiple auto-discoverable files or want to use a different app:
+
+```python
+# Even if you have app.py, you can override it
+import pytest
+from main import my_real_app  # Use this instead of app.py
+
+@pytest.fixture
+def app():
+    return my_real_app
+```
+
+**Option 4 - Setup Wizard**
+Run the interactive setup: `pytest-api-cov init`
+
+The plugin will automatically find your app using the `app` fixture first, then fall back to auto-discovery in common locations. This means you can place your app **anywhere** as long as you create the fixture.
+
+### Multiple App Files
+
+If you have multiple files that could be auto-discovered (e.g., both `app.py` and `main.py`), the plugin will use the **first valid app it finds** in this priority order:
 
-1. Your app is in a standard location (`app.py`, `main.py`, etc.)
-2. Your app variable has a standard name (`app`, `application`, `main`)
-3. Your app imports are correct (`from fastapi import FastAPI` or `from flask import Flask`)
+1. `app.py` 
+2. `main.py`
+3. `server.py`
+4. `wsgi.py`
+5. `asgi.py`
 
-Or use the setup wizard: `pytest-api-cov init`
+To use a specific app when multiple exist, create a `conftest.py` with an `app` fixture pointing to your preferred app.
 
 ### No Endpoints Discovered
 
@@ -315,7 +434,7 @@ If you see "No endpoints discovered":
 
 1. Check that your app is properly instantiated
 2. Verify your routes/endpoints are defined
-3. Ensure the `client` fixture is working in your tests
+3. Ensure the `coverage_client` fixture is working in your tests
 4. Use `-v` or `-vv` for debug information
 
 ### Framework Not Detected

{pytest_api_cov-1.0.0 → pytest_api_cov-1.0.2}/README.md

@@ -26,11 +26,28 @@ For most projects, no configuration is needed:
 pytest --api-cov-report
 ```
 
+### App Location Flexibility
+
+**Zero Config**: Works automatically if your app is in `app.py`, `main.py`, or `server.py`
+
+**Any Location**: Place your app anywhere in your project - just create a `conftest.py`:
+
+```python
+import pytest
+from my_project.backend.api import my_app  # Any import path!
+
+@pytest.fixture
+def app():
+    return my_app
+```
+
 The plugin will automatically discover your Flask/FastAPI app if it's in common locations:
 - `app.py` (with variable `app`, `application`, or `main`)
 - `main.py` (with variable `app`, `application`, or `main`) 
 - `server.py` (with variable `app`, `application`, or `server`)
 
+**Your app can be located anywhere!** If it's not in a standard location, just create a `conftest.py` file to tell the plugin where to find it.
+
 ### Example
 
 Given this FastAPI app in `app.py`:
@@ -56,12 +73,12 @@ def health_check():
 And this test file:
 
 ```python
-def test_root_endpoint(client):
-    response = client.get("/")
+def test_root_endpoint(coverage_client):
+    response = coverage_client.get("/")
     assert response.status_code == 200
 
-def test_get_user(client):
-    response = client.get("/users/123")
+def test_get_user(coverage_client):
+    response = coverage_client.get("/users/123")
     assert response.status_code == 200
 ```
 
@@ -75,6 +92,22 @@ Uncovered Endpoints:
 Total API Coverage: 66.67%
 ```
 
+Or running with advanced options `pytest --api-cov-report --api-cov-show-covered-endpoints --api-cov-exclusion-patterns="/users/*" --api-cov-show-excluded-endpoints --api-cov-report-path=api_coverage.json --api-cov-fail-under=49` produces:
+
+```
+API Coverage Report
+Uncovered Endpoints:
+  [X] /health
+Covered Endpoints:
+  [.] /
+Excluded Endpoints:
+  [-] /users/{user_id}
+
+SUCCESS: Coverage of 50.0% meets requirement of 49.0%
+
+JSON report saved to api_coverage.json
+```
+
 ## Advanced Configuration
 
 ### Setup Wizard
@@ -92,15 +125,56 @@ This will:
 
 ### Manual Configuration
 
-Create a `conftest.py` file:
+Create a `conftest.py` file to specify your app location (works with **any** file path or structure):
 
 ```python
 import pytest
-from your_app import app
+
+# Import from anywhere in your project
+from my_project.backend.api import flask_app
+# or from src.services.web_server import fastapi_instance  
+# or from deeply.nested.modules import my_app
 
 @pytest.fixture
 def app():
-    return app
+    return flask_app  # Return your app instance
+```
+
+This approach works with any project structure - the plugin doesn't care where your app is located as long as you can import it.
+
+### Custom Test Client Fixtures
+
+If you have an existing test client fixture with custom setup (authentication, headers, etc.), you can wrap it with coverage tracking:
+
+```python
+import pytest
+from fastapi.testclient import TestClient
+from your_app import app
+
+@pytest.fixture
+def my_custom_client():
+    """Custom test client with authentication."""
+    client = TestClient(app)
+    client.headers.update({"Authorization": "Bearer test-token"})
+    return client
+
+def test_endpoint(coverage_client):
+    # coverage_client will be your custom client with coverage tracking
+    response = coverage_client.get("/protected-endpoint")
+    assert response.status_code == 200
+```
+
+Configure it in `pyproject.toml`:
+
+```toml
+[tool.pytest_api_cov]
+client_fixture_name = "my_custom_client"
+```
+
+Or via command line:
+
+```bash
+pytest --api-cov-report --api-cov-client-fixture-name=my_custom_client
 ```
 
 ### Configuration Options
@@ -135,6 +209,9 @@ force_sugar = true
 
 # Force no Unicode symbols in output
 force_sugar_disabled = true
+
+# Wrap an existing custom test client fixture with coverage tracking
+client_fixture_name = "my_custom_client"
 ```
 
 ### Command Line Options
@@ -176,7 +253,6 @@ Works automatically with FastAPI and Flask applications.
 
 ```python
 from fastapi import FastAPI
-from fastapi.testclient import TestClient
 
 app = FastAPI()
 
@@ -184,9 +260,9 @@ app = FastAPI()
 def read_item(item_id: int):
     return {"item_id": item_id}
 
-# Tests automatically get a 'client' fixture
-def test_read_item(client):
-    response = client.get("/items/42")
+# Tests automatically get a 'coverage_client' fixture
+def test_read_item(coverage_client):
+    response = coverage_client.get("/items/42")
     assert response.status_code == 200
 ```
 
@@ -201,9 +277,9 @@ app = Flask(__name__)
 def get_user(user_id):
     return {"user_id": user_id}
 
-# Tests automatically get a 'client' fixture  
-def test_get_user(client):
-    response = client.get("/users/123")
+# Tests automatically get a 'coverage_client' fixture  
+def test_get_user(coverage_client):
+    response = coverage_client.get("/users/123")
     assert response.status_code == 200
 ```
 
@@ -283,13 +359,56 @@ jobs:
 
 ### No App Found
 
-If you see "No API app found", ensure:
+If you see "No API app found", you have several options:
+
+**Option 1 - Auto-discovery (Zero Config)**
+Place your app in a standard location with a standard name:
+- Files: `app.py`, `main.py`, `server.py`, `wsgi.py`, `asgi.py`
+- Variable names: `app`, `application`, `main`, `server`
+
+**Option 2 - Custom Location (Any File/Path)**
+Create a `conftest.py` file to specify your app location:
+
+```python
+import pytest
+from my_project.api.server import my_flask_app  # Any import path
+# or from src.backend.main import fastapi_instance
+# or from anywhere import your_app
+
+@pytest.fixture
+def app():
+    return my_flask_app  # Return your app instance
+```
+
+**Option 3 - Override Auto-discovery**
+If you have multiple auto-discoverable files or want to use a different app:
+
+```python
+# Even if you have app.py, you can override it
+import pytest
+from main import my_real_app  # Use this instead of app.py
+
+@pytest.fixture
+def app():
+    return my_real_app
+```
+
+**Option 4 - Setup Wizard**
+Run the interactive setup: `pytest-api-cov init`
+
+The plugin will automatically find your app using the `app` fixture first, then fall back to auto-discovery in common locations. This means you can place your app **anywhere** as long as you create the fixture.
+
+### Multiple App Files
+
+If you have multiple files that could be auto-discovered (e.g., both `app.py` and `main.py`), the plugin will use the **first valid app it finds** in this priority order:
 
-1. Your app is in a standard location (`app.py`, `main.py`, etc.)
-2. Your app variable has a standard name (`app`, `application`, `main`)
-3. Your app imports are correct (`from fastapi import FastAPI` or `from flask import Flask`)
+1. `app.py` 
+2. `main.py`
+3. `server.py`
+4. `wsgi.py`
+5. `asgi.py`
 
-Or use the setup wizard: `pytest-api-cov init`
+To use a specific app when multiple exist, create a `conftest.py` with an `app` fixture pointing to your preferred app.
 
 ### No Endpoints Discovered
 
@@ -297,7 +416,7 @@ If you see "No endpoints discovered":
 
 1. Check that your app is properly instantiated
 2. Verify your routes/endpoints are defined
-3. Ensure the `client` fixture is working in your tests
+3. Ensure the `coverage_client` fixture is working in your tests
 4. Use `-v` or `-vv` for debug information
 
 ### Framework Not Detected

{pytest_api_cov-1.0.0 → pytest_api_cov-1.0.2}/pyproject.toml

@@ -1,23 +1,21 @@
 [project]
 name = "pytest-api-cov"
-version = "1.0.0"
-description = "Api Coverage Report Pytest Plugin"
+version = "1.0.2"
+description = "Pytest Plugin to provide API Coverage statistics for Python Web Frameworks"
 readme = "README.md"
-authors = [
-    {name = "Barnaby Gill", email = "barnabasgill@gmail.com"},
-]
-license = {text = "Apache-2.0"}
+authors = [{ name = "Barnaby Gill", email = "barnabasgill@gmail.com" }]
+license = { text = "Apache-2.0" }
 requires-python = ">=3.10"
 
 dependencies = [
-    "fastapi>=0.116.1",
-    "flask>=3.1.1",
-    "httpx>=0.28.1",
-    "pydantic>=2.11.7",
-    "rich>=14.0.0",
-    "starlette>=0.47.1",
-    "tomli>=2.2.1",
-    "pytest>=8.4.1",
+    "fastapi>=0.68.0",
+    "flask>=2.0.0",
+    "httpx>=0.20.0",
+    "pydantic>=2.0.0",
+    "rich>=10.0.0",
+    "starlette>=0.14.0",
+    "tomli>=1.2.0",
+    "pytest>=6.0.0",
 ]
 
 [dependency-groups]
@@ -32,13 +30,11 @@ dev = [
 
 # API COVERAGE
 [tool.pytest_api_cov]
-# fail_under = 95.0  # in the command
+fail_under = 70
 show_covered_endpoints = true
 show_uncovered_endpoints = true
 show_excluded_endpoints = true
-exclusion_patterns = [
-    "xyz",
-]
+exclusion_patterns = ["xyz"]
 report_path = "reports/pytest_api_cov.json"
 
 [tool.pytest.ini_options]
@@ -46,12 +42,8 @@ testpaths = ["tests/unit", "tests/integration", "example/tests"]
 pythonpath = ["src"]
 
 [tool.coverage.report]
-exclude_lines = [
-    'if __name__ == "__main__":',
-    "if TYPE_CHECKING:",
-]
+exclude_lines = ['if __name__ == "__main__":', "if TYPE_CHECKING:"]
 show_missing = true
-fail_under = 70.0
 
 
 [build-system]
@@ -62,12 +54,7 @@ build-backend = "hatchling.build"
 packages = ["src/pytest_api_cov"]
 
 [tool.hatch.build.targets.sdist]
-include = [
-    "src/pytest_api_cov/",
-    "README.md",
-    "LICENSE",
-    "pyproject.toml",
-]
+include = ["src/pytest_api_cov/", "README.md", "LICENSE", "pyproject.toml"]
 
 # [[tool.uv.index]]
 # name = "testpypi"

{pytest_api_cov-1.0.0 → pytest_api_cov-1.0.2}/src/pytest_api_cov/__init__.py

@@ -2,6 +2,7 @@
 
 try:
     from importlib.metadata import version
+
     __version__ = version("pytest-api-cov")
 except ImportError:
     __version__ = "unknown"

{pytest_api_cov-1.0.0 → pytest_api_cov-1.0.2}/src/pytest_api_cov/cli.py

@@ -56,22 +56,36 @@ def generate_conftest_content(framework: str, file_path: str, app_variable: str)
 
 import pytest
 
-# Import your {framework} app
+# Import your {framework} app from anywhere in your project
 from {module_path} import {app_variable}
 
 
 @pytest.fixture
-def client():
-    """Provide the {framework} client for API coverage testing.
-    
-    In your test:
-    ```
-    def test_root_endpoint(client):
-        response = client.get("/")
-        assert response.status_code == 200
-    ```
+def app():
+    """Provide the {framework} app for API coverage testing.
+
+    You can import from any location - just change the import path above
+    to match your project structure.
     """
     return {app_variable}
+
+
+# The plugin will automatically create a 'coverage_client' fixture that uses your 'app' fixture
+# You can use either:
+# - def test_endpoint(app): ...  # Direct app access
+# - def test_endpoint(coverage_client): ...  # Test client with API coverage tracking
+#
+# To wrap an existing custom fixture instead, specify the fixture name in pyproject.toml:
+# [tool.pytest_api_cov]
+# client_fixture_name = "my_custom_client"
+#
+# Example custom fixture:
+# @pytest.fixture
+# def my_custom_client(app):
+#     client = app.test_client()  # Flask
+#     # or client = TestClient(app)  # FastAPI
+#     # Add custom setup here (auth headers, etc.)
+#     return client
 '''
 
 
@@ -100,6 +114,9 @@ show_excluded_endpoints = false
 
 # Force Unicode symbols in terminal output (optional)
 # force_sugar = true
+
+# Wrap an existing custom test client fixture with coverage tracking (optional)
+# client_fixture_name = "my_custom_client"
 """
 
 
@@ -152,13 +169,13 @@ testpaths = ["tests"]
         print("🎉 Setup complete!")
         print()
         print("Next steps:")
-        print("1. Write your tests using the 'client' fixture")
+        print("1. Write your tests using the 'coverage_client' fixture")
         print("2. Run: pytest --api-cov-report")
         print()
         print("Example test:")
         print("""
-def test_root_endpoint(client):
-    response = client.get("/")
+def test_root_endpoint(coverage_client):
+    response = coverage_client.get("/")
     assert response.status_code == 200
 """)
 

{pytest_api_cov-1.0.0 → pytest_api_cov-1.0.2}/src/pytest_api_cov/config.py

@@ -20,6 +20,7 @@ class ApiCoverageReportConfig(BaseModel):
     report_path: Optional[str] = Field(None, alias="api-cov-report-path")
     force_sugar: bool = Field(False, alias="api-cov-force-sugar")
     force_sugar_disabled: bool = Field(False, alias="api-cov-force-sugar-disabled")
+    client_fixture_name: str = Field("coverage_client", alias="api-cov-client-fixture-name")
 
 
 def read_toml_config() -> Dict[str, Any]:
@@ -43,6 +44,7 @@ def read_session_config(session_config: Any) -> Dict[str, Any]:
         "api-cov-report-path": "report_path",
         "api-cov-force-sugar": "force_sugar",
         "api-cov-force-sugar-disabled": "force_sugar_disabled",
+        "api-cov-client-fixture-name": "client_fixture_name",
     }
     config = {}
     for opt, key in cli_options.items():