pytest-api-core 1.0.1__py3-none-any.whl

pytest_api_core-1.0.1.dist-info/METADATA

@@ -0,0 +1,314 @@
+Metadata-Version: 2.4
+Name: pytest-api-core
+Version: 1.0.1
+Summary: Pytest API automation framework with custom HTML reporting, reusable fixtures, and fluent assertions
+Author: QA Platform Team
+License: MIT License
+        
+        Copyright (c) 2026 Subodh Singh
+        
+        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.
+        
+Project-URL: Repository, https://github.com/your-org/pytest-api-core-framework
+Project-URL: Documentation, https://your-org.artifactory.com/docs/pytest-api-core
+Keywords: pytest,api,testing,automation,html-report
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Testing
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest>=7.4
+Requires-Dist: requests>=2.31
+Requires-Dist: Jinja2>=3.1
+Requires-Dist: urllib3>=2.0
+Requires-Dist: jsonschema>=4.20
+Provides-Extra: dotenv
+Requires-Dist: python-dotenv>=1.0; extra == "dotenv"
+Provides-Extra: dev
+Requires-Dist: pytest-mock>=3.12; extra == "dev"
+Requires-Dist: responses>=0.25; extra == "dev"
+Requires-Dist: black>=24.0; extra == "dev"
+Requires-Dist: isort>=5.13; extra == "dev"
+Requires-Dist: mypy>=1.8; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Dynamic: license-file
+
+# pytest-api-core
+
+> A reusable pytest API automation framework with fluent assertions, built-in auth strategies, environment-aware configuration, and a beautiful custom HTML report — packaged for Artifactory distribution.
+
+## Features
+
+- **`APIClient`** — `requests.Session` wrapper with retry, timeout, and structured logging
+- **Fluent response assertions** — `assert_that(response).status_is(200).json_path("$.id").equals(1)`
+- **Auth strategies** — Bearer token, Basic, API Key (header/query), OAuth2 client credentials
+- **Environment config** — Python `settings.py` classes + `.env` file + `ENV_VAR` overrides via `api_config` fixture
+- **Custom HTML report** — self-contained report with charts, filterable table, captured logs, and request/response details
+- **Auto-registered pytest fixtures** — zero boilerplate in consuming projects
+
+---
+
+## Installation
+
+### From private PyPI
+
+```bash
+pip install pytest-api-core \
+  --index-url https://pypi.example.com/simple/
+```
+
+With `.env` support (optional but recommended):
+
+```bash
+pip install "pytest-api-core[dotenv]"
+```
+
+Or add to `requirements.txt` / `pyproject.toml`:
+
+```
+pytest-api-core==1.0.0
+```
+
+---
+
+## Quick Start
+
+### 1. Create environment settings
+
+```python
+# config/settings.py
+import os
+from pytest_api_core.config.base_settings import BaseSettings
+
+class DevSettings(BaseSettings):
+    base_url = "https://api.dev.example.com"
+    timeout  = 30
+    verify_ssl = True
+    headers  = {"Accept": "application/json", "Content-Type": "application/json"}
+
+class StagingSettings(DevSettings):
+    base_url = os.environ.get("API_BASE_URL", "https://api.staging.example.com")
+    timeout  = 60
+
+ENVIRONMENTS = {
+    "dev":     DevSettings,
+    "staging": StagingSettings,
+}
+```
+
+### 2. Store secrets in `.env` (never commit this file)
+
+```ini
+# .env
+BEARER_TOKEN=eyJhbGciOiJIUzI1NiIs...
+API_KEY=super-secret-key
+```
+
+### 3. Configure pytest.ini
+
+```ini
+[pytest]
+
+# ── Framework ────────────────────────────────────────────────────────────────
+api_env             = dev
+api_settings_module = config.settings
+api_dotenv_file     = .env
+
+# ── Report ───────────────────────────────────────────────────────────────────
+addopts = --api-html-report=reports/{env}/report_{timestamp}.html -v
+api_html_theme      = dark            # or "light"
+api_html_title      = API Test Report # browser tab title
+api_html_header     = API Test Report # page header text
+
+# ── Logging ──────────────────────────────────────────────────────────────────
+api_log_level       = INFO
+log_cli             = true
+log_cli_level       = INFO
+log_cli_format      = %(asctime)s [%(levelname)-8s] %(name)s: %(message)s
+log_cli_date_format = %H:%M:%S
+```
+
+### 4. Write tests
+
+```python
+# tests/test_posts.py
+from pytest_api_core.assertions import assert_that
+
+def test_get_post(api_client):
+    response = api_client.get("/posts/1")
+    assert_that(response).status_is(200).json_path("$.id").equals(1)
+
+def test_create_post(api_client):
+    payload = {"title": "foo", "body": "bar", "userId": 1}
+    response = api_client.post("/posts", json=payload)
+    assert_that(response).status_is(201).has_key("id")
+```
+
+### 5. Run with HTML report
+
+```bash
+pytest tests/ --api-env=staging
+```
+
+The report is written to `reports/staging/report_<timestamp>.html`.
+
+---
+
+## Configuration
+
+### Resolution order (highest → lowest priority)
+
+| Priority | Source |
+|---|---|
+| 1 | Shell / CI environment variables (`API_BASE_URL`, `API_TOKEN`, …) |
+| 2 | `--api-base-url` CLI flag |
+| 3 | `ENVIRONMENTS[env]` class in `settings_module` |
+| 4 | Built-in defaults (`http://localhost`, timeout 30 s, …) |
+
+### pytest.ini options
+
+| Option | Description | Default |
+|---|---|---|
+| `api_env` | Active environment name | `dev` |
+| `api_settings_module` | Dotted path to settings module | — |
+| `api_dotenv_file` | Path to `.env` file | `.env` |
+| `api_log_level` | Log level for framework internals | `WARNING` |
+| `api_html_report` | Output path for HTML report (supports `{env}`, `{timestamp}`) | — |
+| `api_html_theme` | Report theme: `light` or `dark` | `dark` |
+| `api_html_title` | Browser tab title text | `API Test Report` |
+| `api_html_header` | Page header text | `API Test Report` |
+
+### CLI flags
+
+| Flag | Description |
+|---|---|
+| `--api-env` | Override active environment |
+| `--api-base-url` | Override `base_url` |
+| `--api-log-level` | Override framework log level |
+| `--api-html-report` | Override HTML report path |
+
+### Environment variables
+
+| Variable | Purpose |
+|---|---|
+| `API_BASE_URL` | Override `base_url` |
+| `API_TOKEN` | Inject Bearer token (auto-applied by `api_client`) |
+| `API_ENV` | Select environment |
+| `API_TIMEOUT` | Override request timeout |
+| `API_VERIFY_SSL` | Override SSL verification |
+
+---
+
+## Fixtures
+
+| Fixture | Scope | Description |
+|---|---|---|
+| `api_config` | session | Resolved config dict for the active env |
+| `api_client` | session | Configured `APIClient` instance |
+| `api_bearer_auth` | function | `BearerAuth` built from `API_TOKEN` env var |
+| `api_basic_auth` | function | `BasicAuth` built from `API_USERNAME` / `API_PASSWORD` |
+| `api_key_auth` | function | `APIKeyAuth` built from `API_KEY_NAME` / `API_KEY_VALUE` |
+
+### Overriding `api_client` per project
+
+```python
+# tests/conftest.py
+import pytest
+from pytest_api_core.auth.auth_handlers import BearerAuth
+from pytest_api_core.client.api_client import APIClient
+from pytest_api_core.config.env_loader import get_env
+
+@pytest.fixture(scope="session")
+def api_client(api_config):
+    token = get_env("BEARER_TOKEN", required=True)
+    client = APIClient(
+        base_url=api_config["base_url"],
+        auth=BearerAuth(token),
+        timeout=api_config.get("timeout", 30),
+        verify_ssl=api_config.get("verify_ssl", True),
+        default_headers=api_config.get("headers"),
+    )
+    yield client
+    client.close()
+```
+
+---
+
+## Publishing
+
+### Via GitHub Actions (Recommended)
+
+Use the **Publish to Public PyPI** workflow for automated releases:
+
+1. Go to **Actions** → **Publish to Public PyPI**
+2. Click **Run workflow**
+3. Enter version (e.g., `1.0.1`) and enable/disable tests
+4. Workflow will build, test, and publish to PyPI
+
+See [docs/PUBLISHING.md](docs/PUBLISHING.md) for detailed setup instructions.
+
+### Manual Publishing
+
+```bash
+# Build
+python -m build
+
+# Upload to PyPI
+twine upload dist/*
+
+# Or upload to private registry
+twine upload \
+  --repository-url https://pypi.example.com \
+  -u <user> -p <token> \
+  dist/*
+```
+
+---
+
+## Project Layout
+
+```
+src/
+└── pytest_api_core/
+    ├── plugin.py           # pytest entry-point
+    ├── client/             # HTTP client + response wrapper
+    ├── auth/               # Auth strategy classes
+    ├── config/             # Config manager, BaseSettings, env_loader
+    ├── fixtures/           # Auto-registered pytest fixtures
+    ├── assertions/         # Fluent response assertion API
+    └── reporters/          # Custom HTML report plugin
+config/
+└── settings.py             # Project environment settings (not shipped in wheel)
+tests/                      # Package self-tests
+```
+
+---
+
+## License
+
+See [LICENSE](LICENSE).

pytest_api_core-1.0.1.dist-info/RECORD

@@ -0,0 +1,24 @@
+pytest_api_core/__init__.py,sha256=k1sLp0q5McZ-xx46tqz2qHfZOAQoFnuacFLSOkQa6ng,606
+pytest_api_core/plugin.py,sha256=ztZUdEnLZAqjooth7I3-L_IbFkjIMw38XAw0LmlVRrg,4720
+pytest_api_core/assertions/__init__.py,sha256=nTgAKLFR-po-akWbWUPhugs_6vC7joZ1KsKs1yCRCPo,140
+pytest_api_core/assertions/response_assertions.py,sha256=ypDrTFYZQPz7-8nmntbJvxbh-LnWU2teEBFNFHDyvXE,13735
+pytest_api_core/auth/__init__.py,sha256=2MZWga1KltncKtWS6BjFWZNlWxW-ZQLyNNMBptir1DA,207
+pytest_api_core/auth/auth_handlers.py,sha256=yZI5SiAiMBURPklGztCiwDcIWgYq-tTI2Wsk2s_pogI,4961
+pytest_api_core/client/__init__.py,sha256=BzEGJ-vtVIBxtbPKo51GZiNP4ta4VerHNh1vY7tTzGc,156
+pytest_api_core/client/api_client.py,sha256=8d-ft6BiljouxJFvO5ZbXFfrpCD4V9eEuO2AwCWmZDY,5866
+pytest_api_core/client/api_response.py,sha256=SEfjCelE8x2TCvRCh-1fLhBhkNRL0doCxKQfoWsSi7c,3259
+pytest_api_core/config/__init__.py,sha256=AB-ZPcczHdj2QXfNVegJI6zpvrPwB12tk1p6ZKVqJBQ,93
+pytest_api_core/config/base_settings.py,sha256=kSZfpM7Qb_VdxoQt0iFx9aWoLyqwYaQ-yBn_EVUHUsM,1588
+pytest_api_core/config/config_manager.py,sha256=C4l9zYCbqYQkR8fi52UJRkDSag1Npi5Siw40hkRj-MA,4943
+pytest_api_core/config/env_loader.py,sha256=ZdqvYlheLVeMlUxkPjsneB_J-p0-53KTg4JnJCCKSDs,3624
+pytest_api_core/fixtures/__init__.py,sha256=pym_n1dGNyMjsMJ8pBvpRhL6NO1AOxAz9GCAk7buPo4,238
+pytest_api_core/fixtures/api_fixtures.py,sha256=hWHaF1UAb05LtOLnBPOcx9X8RTYOFldjiwke-r0YzHE,4533
+pytest_api_core/reporters/__init__.py,sha256=x8Nz9l_XVJ6UnhiWagpGiYpavRn1rT_19URxmJx51WA,93
+pytest_api_core/reporters/html_reporter.py,sha256=4t_Ct9pgzpdnmyuIVz5J7i9Afs3KshHrqkO2UfsBpwo,9135
+pytest_api_core/reporters/templates/report.html,sha256=FttRFPEyu0QkGWBCz7X6C_voavCqiI-fhwL55TmLeJw,23471
+pytest_api_core-1.0.1.dist-info/licenses/LICENSE,sha256=KX3V5BBuPfOzHocmg7neh05ynY2-SuUIQcKTUWY_YRA,1069
+pytest_api_core-1.0.1.dist-info/METADATA,sha256=lLd9idA_F_vZp0GDa8R5BUq7Ioo3-IfLq_atFumzWn8,10411
+pytest_api_core-1.0.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+pytest_api_core-1.0.1.dist-info/entry_points.txt,sha256=zLSsWALblfMzUMTQ9XNtWm1DadnIEXZIGdcaRDXzxYk,52
+pytest_api_core-1.0.1.dist-info/top_level.txt,sha256=1Oc_pFT9Ma9pS94FlcPYoAp6op8BJBVccq2CVXybApo,16
+pytest_api_core-1.0.1.dist-info/RECORD,,

pytest_api_core-1.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pytest_api_core-1.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+pytest-api-core = pytest_api_core.plugin

pytest_api_core-1.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Subodh Singh
+
+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.

pytest_api_core-1.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+pytest_api_core