Merge pull request #6 from MehrazRumman/wip

updates

Author: MehrazRumman

.github/workflows/coverage-badge.yml

@@ -30,7 +30,7 @@ jobs:
 
       - name: Run tests with coverage
         run: |
-          pytest -q --cov=fastapi_observer --cov-report=term-missing --cov-report=xml
+          pytest -q --cov=fastapi_inspector --cov-report=term-missing --cov-report=xml
 
       - name: Generate coverage badge
         run: |

CONTRIBUTING.md

@@ -32,7 +32,7 @@ Thank you for your interest in contributing!
 pytest -q
 
 # Run with coverage report
-pytest --cov=fastapi_observer --cov-report=term-missing
+pytest --cov=fastapi_inspector --cov-report=term-missing
 
 # Run a specific test file
 pytest tests/test_middleware.py -v

docs/api-reference.md

@@ -47,5 +47,5 @@ The storage package provides:
 
 ## Logger helpers
 
-- `build_logger(config, logger_name="fastapi_observer")`
+- `build_logger(config, logger_name="fastapi_inspector")`
 - `log_event(logger, config, event)`

docs/best-practices.md

@@ -10,7 +10,7 @@
 ## Recommended baseline
 
 ```python
-from fastapi_observer import ObserverConfig
+from fastapi_inspector import ObserverConfig
 
 config = ObserverConfig(
     exclude_paths=["/health", "/metrics"],

docs/configuration.md

@@ -27,7 +27,7 @@ Paths are normalized before matching:
 ## Example
 
 ```python
-from fastapi_observer import ObserverConfig
+from fastapi_inspector import ObserverConfig
 
 config = ObserverConfig(
     handlers=["console", "file"],

docs/dashboard.md

@@ -14,8 +14,8 @@
 The dashboard works with any object that implements the `EventStore` protocol.
 
 ```python
-from fastapi_observer.dashboard import build_dashboard_app
-from fastapi_observer.storage import InMemoryEventStore
+from fastapi_inspector.dashboard import build_dashboard_app
+from fastapi_inspector.storage import InMemoryEventStore
 
 app = build_dashboard_app(InMemoryEventStore())
 ```

docs/handlers.md

@@ -19,9 +19,9 @@ The package currently ships with console and file logging handlers.
 `build_handlers(config, formatter)` preserves the order from `config.handlers`.
 
 ```python
-from fastapi_observer import ObserverConfig
-from fastapi_observer.handlers import build_handlers
-from fastapi_observer.formatters import JsonFormatter
+from fastapi_inspector import ObserverConfig
+from fastapi_inspector.handlers import build_handlers
+from fastapi_inspector.formatters import JsonFormatter
 
 config = ObserverConfig(handlers=["file", "console"], file_path="logs/api.log")
 handlers = build_handlers(config, JsonFormatter())

docs/installation.md

@@ -15,7 +15,7 @@ pip install -e ".[test,docs,dev]"
 ## Run tests locally
 
 ```bash
-pytest -q --cov=fastapi_observer --cov-report=term-missing --cov-report=xml
+pytest -q --cov=fastapi_inspector --cov-report=term-missing --cov-report=xml
 ```
 
 ## Run multi-version tests with tox

docs/quickstart.md

@@ -4,7 +4,7 @@ Add the middleware to a FastAPI app and choose the logging behavior through `Obs
 
 ```python
 from fastapi import FastAPI
-from fastapi_observer import ObserverConfig, ObserverMiddleware
+from fastapi_inspector import ObserverConfig, ObserverMiddleware
 
 app = FastAPI()
 
@@ -29,7 +29,7 @@ app.add_middleware(ObserverMiddleware, config=config)
 
 ```python
 from fastapi import FastAPI
-from fastapi_observer import ObserverConfig, ObserverMiddleware
+from fastapi_inspector import ObserverConfig, ObserverMiddleware
 
 app = FastAPI()
 app.add_middleware(ObserverMiddleware, config=ObserverConfig())

examples/basic_usage.py

@@ -1,6 +1,6 @@
 from fastapi import FastAPI
 
-from fastapi_observer import ObserverConfig, ObserverMiddleware
+from fastapi_inspector import ObserverConfig, ObserverMiddleware
 
 app = FastAPI(title="FastAPI Observer Example")