replayx 0.1.0__tar.gz

replayx-0.1.0/.gitignore

@@ -0,0 +1,26 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+coverage.xml
+
+# Editors / OS
+.idea/
+.vscode/
+.DS_Store

replayx-0.1.0/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project are documented here. The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-06-22
+
+### Added
+- Initial release.
+- `use_cassette` context manager that transparently patches `httpx` to record
+  and replay interactions.
+- Synchronous (`ReplayTransport`) and asynchronous (`AsyncReplayTransport`)
+  transports for explicit, no-magic usage.
+- Four record modes: `once`, `new_episodes`, `none`, `all`.
+- Configurable request matchers (`method`, `url`, `host`, `path`, `query`,
+  `headers`, `body`, ...).
+- Secret redaction via `filter_headers`, `filter_query_params`, and
+  `before_record_request` / `before_record_response` hooks.
+- JSON cassettes by default; optional YAML cassettes via the `yaml` extra.
+- A `pytest` plugin exposing the `replayx_cassette` fixture and a
+  `--replayx-record` flag.
+
+[Unreleased]: https://github.com/mkusiappiah/replayx/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/mkusiappiah/replayx/releases/tag/v0.1.0

replayx-0.1.0/LICENSE

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

replayx-0.1.0/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.4
+Name: replayx
+Version: 0.1.0
+Summary: Record and replay HTTP interactions for httpx — an async-native VCR for fast, deterministic tests.
+Project-URL: Homepage, https://github.com/mkusiappiah/replayx
+Project-URL: Repository, https://github.com/mkusiappiah/replayx
+Project-URL: Issues, https://github.com/mkusiappiah/replayx/issues
+Project-URL: Changelog, https://github.com/mkusiappiah/replayx/blob/main/CHANGELOG.md
+Author-email: Michael Kusi-Appiah <appiah.michael@yahoo.com>
+License: MIT License
+        
+        Copyright (c) 2026 Michael Kusi-Appiah
+        
+        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.
+License-File: LICENSE
+Keywords: async,asyncio,http,httpx,mock,pytest,record,replay,testing,vcr
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Testing :: Mocking
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.23
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=7.4; extra == 'dev'
+Requires-Dist: pyyaml>=6.0; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Requires-Dist: types-pyyaml; extra == 'dev'
+Provides-Extra: yaml
+Requires-Dist: pyyaml>=6.0; extra == 'yaml'
+Description-Content-Type: text/markdown
+
+# replayx
+
+Record and replay HTTP interactions for [httpx](https://www.python-httpx.org/). Run your tests fast and offline.
+
+[![CI](https://github.com/mkusiappiah/replayx/actions/workflows/ci.yml/badge.svg)](https://github.com/mkusiappiah/replayx/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/replayx.svg)](https://pypi.org/project/replayx/)
+[![Python versions](https://img.shields.io/pypi/pyversions/replayx.svg)](https://pypi.org/project/replayx/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+replayx saves real HTTP responses to a cassette file on the first test run. Every later run reads from the cassette. No network calls. No flaky tests. No slow CI.
+
+```python
+import httpx
+from replayx import use_cassette
+
+with use_cassette("cassettes/github.json"):
+    resp = httpx.get("https://api.github.com/users/octocat")
+    assert resp.json()["login"] == "octocat"
+```
+
+The first run records. Later runs replay.
+
+## Why I built replayx
+
+vcrpy brought record and replay to Python. vcrpy targets requests and the sync world. I built replayx for modern httpx code.
+
+| Feature | replayx | vcrpy |
+| --- | --- | --- |
+| Async httpx.AsyncClient | yes | limited |
+| Built for httpx | yes | through patches |
+| Zero deps beyond httpx | yes (JSON) | needs PyYAML |
+| Secret redaction for committed cassettes | yes | partial |
+| Explicit transport API, no patching | yes | no |
+| Modern typing with py.typed | yes | no |
+
+## Install
+
+```bash
+pip install replayx
+```
+
+Add YAML cassettes:
+
+```bash
+pip install "replayx[yaml]"
+```
+
+replayx needs Python 3.9 or newer and httpx 0.23 or newer.
+
+## Usage
+
+### Patch httpx with use_cassette
+
+use_cassette patches httpx for the block. Your existing client code runs without changes. Sync and async both work.
+
+```python
+import httpx
+from replayx import use_cassette
+
+async def fetch():
+    async with httpx.AsyncClient() as client:
+        return await client.get("https://api.example.com/data")
+
+with use_cassette("cassettes/data.json"):
+    resp = await fetch()
+```
+
+### Build a transport yourself
+
+Prefer no patching? Build a transport and pass the transport to your client. Nothing gets monkeypatched.
+
+```python
+import httpx
+from replayx import Cassette
+
+cassette = Cassette.load("cassettes/data.json", record_mode="once")
+
+with httpx.Client(transport=cassette.sync_transport()) as client:
+    resp = client.get("https://api.example.com/data")
+
+cassette.save()
+```
+
+Use `cassette.async_transport()` with `httpx.AsyncClient` for async code.
+
+### The pytest plugin
+
+The plugin gives each test an auto-named cassette at `<test-dir>/cassettes/<test-name>.json`.
+
+```python
+import httpx
+
+def test_octocat(replayx_cassette):
+    with replayx_cassette():
+        resp = httpx.get("https://api.github.com/users/octocat")
+        assert resp.status_code == 200
+```
+
+Re-record a whole run from the command line:
+
+```bash
+pytest --replayx-record=all
+```
+
+Set per-test defaults with the marker:
+
+```python
+import pytest
+
+@pytest.mark.replayx(match_on=("method", "url", "body"), filter_headers=["authorization"])
+def test_create(replayx_cassette):
+    with replayx_cassette():
+        ...
+```
+
+## Record modes
+
+| Mode | What happens |
+| --- | --- |
+| once (default) | Replay an existing cassette. Record everything when no cassette exists. A new request against an existing cassette raises an error. |
+| new_episodes | Replay matches and append new interactions. |
+| none | Replay only. No network. No writes. Good for CI. |
+| all | Always reach the real backend and overwrite the cassette. Use to re-record. |
+
+```python
+with use_cassette("cassettes/api.json", record_mode="none"):
+    ...
+```
+
+## Match requests
+
+Requests match on method and url by default. Query order does not affect matching. Change the rules with match_on.
+
+```python
+with use_cassette("cassettes/api.json", match_on=("method", "path", "body")):
+    ...
+```
+
+Available matchers: method, scheme, host, port, path, query, url (alias uri), headers, body.
+
+## Redact secrets
+
+Commit cassettes without leaking credentials. Redaction runs at record time. The live response your code receives stays intact.
+
+```python
+with use_cassette(
+    "cassettes/api.json",
+    filter_headers=["authorization", "set-cookie"],
+    filter_query_params=["api_key", "token"],
+):
+    ...
+```
+
+Use hooks for full control. Return a changed recording, or return None to skip the recording.
+
+```python
+from dataclasses import replace
+
+def scrub_body(response):
+    return replace(response, body=b'{"token": "REDACTED"}')
+
+with use_cassette("cassettes/api.json", before_record_response=scrub_body):
+    ...
+```
+
+## Cassette format
+
+Cassettes use plain JSON. YAML works with the yaml extra. Both read well in code review.
+
+```json
+{
+  "version": 1,
+  "recorded_with": "replayx/0.1.0",
+  "interactions": [
+    {
+      "request": { "method": "GET", "url": "https://api.example.com/data", "headers": [], "body": null },
+      "response": { "status_code": 200, "headers": [["content-type", "application/json"]], "body": { "text": "{\"ok\":true}" } }
+    }
+  ]
+}
+```
+
+replayx stores binary bodies as base64.
+
+## Contribute
+
+I welcome contributions. Set up a dev environment:
+
+```bash
+git clone https://github.com/mkusiappiah/replayx
+cd replayx
+pip install -e ".[dev]"
+pytest
+ruff check .
+mypy
+```
+
+Open an issue before large changes.
+
+## License
+
+MIT. See [LICENSE](LICENSE).

replayx-0.1.0/README.md

@@ -0,0 +1,202 @@
+# replayx
+
+Record and replay HTTP interactions for [httpx](https://www.python-httpx.org/). Run your tests fast and offline.
+
+[![CI](https://github.com/mkusiappiah/replayx/actions/workflows/ci.yml/badge.svg)](https://github.com/mkusiappiah/replayx/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/replayx.svg)](https://pypi.org/project/replayx/)
+[![Python versions](https://img.shields.io/pypi/pyversions/replayx.svg)](https://pypi.org/project/replayx/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+replayx saves real HTTP responses to a cassette file on the first test run. Every later run reads from the cassette. No network calls. No flaky tests. No slow CI.
+
+```python
+import httpx
+from replayx import use_cassette
+
+with use_cassette("cassettes/github.json"):
+    resp = httpx.get("https://api.github.com/users/octocat")
+    assert resp.json()["login"] == "octocat"
+```
+
+The first run records. Later runs replay.
+
+## Why I built replayx
+
+vcrpy brought record and replay to Python. vcrpy targets requests and the sync world. I built replayx for modern httpx code.
+
+| Feature | replayx | vcrpy |
+| --- | --- | --- |
+| Async httpx.AsyncClient | yes | limited |
+| Built for httpx | yes | through patches |
+| Zero deps beyond httpx | yes (JSON) | needs PyYAML |
+| Secret redaction for committed cassettes | yes | partial |
+| Explicit transport API, no patching | yes | no |
+| Modern typing with py.typed | yes | no |
+
+## Install
+
+```bash
+pip install replayx
+```
+
+Add YAML cassettes:
+
+```bash
+pip install "replayx[yaml]"
+```
+
+replayx needs Python 3.9 or newer and httpx 0.23 or newer.
+
+## Usage
+
+### Patch httpx with use_cassette
+
+use_cassette patches httpx for the block. Your existing client code runs without changes. Sync and async both work.
+
+```python
+import httpx
+from replayx import use_cassette
+
+async def fetch():
+    async with httpx.AsyncClient() as client:
+        return await client.get("https://api.example.com/data")
+
+with use_cassette("cassettes/data.json"):
+    resp = await fetch()
+```
+
+### Build a transport yourself
+
+Prefer no patching? Build a transport and pass the transport to your client. Nothing gets monkeypatched.
+
+```python
+import httpx
+from replayx import Cassette
+
+cassette = Cassette.load("cassettes/data.json", record_mode="once")
+
+with httpx.Client(transport=cassette.sync_transport()) as client:
+    resp = client.get("https://api.example.com/data")
+
+cassette.save()
+```
+
+Use `cassette.async_transport()` with `httpx.AsyncClient` for async code.
+
+### The pytest plugin
+
+The plugin gives each test an auto-named cassette at `<test-dir>/cassettes/<test-name>.json`.
+
+```python
+import httpx
+
+def test_octocat(replayx_cassette):
+    with replayx_cassette():
+        resp = httpx.get("https://api.github.com/users/octocat")
+        assert resp.status_code == 200
+```
+
+Re-record a whole run from the command line:
+
+```bash
+pytest --replayx-record=all
+```
+
+Set per-test defaults with the marker:
+
+```python
+import pytest
+
+@pytest.mark.replayx(match_on=("method", "url", "body"), filter_headers=["authorization"])
+def test_create(replayx_cassette):
+    with replayx_cassette():
+        ...
+```
+
+## Record modes
+
+| Mode | What happens |
+| --- | --- |
+| once (default) | Replay an existing cassette. Record everything when no cassette exists. A new request against an existing cassette raises an error. |
+| new_episodes | Replay matches and append new interactions. |
+| none | Replay only. No network. No writes. Good for CI. |
+| all | Always reach the real backend and overwrite the cassette. Use to re-record. |
+
+```python
+with use_cassette("cassettes/api.json", record_mode="none"):
+    ...
+```
+
+## Match requests
+
+Requests match on method and url by default. Query order does not affect matching. Change the rules with match_on.
+
+```python
+with use_cassette("cassettes/api.json", match_on=("method", "path", "body")):
+    ...
+```
+
+Available matchers: method, scheme, host, port, path, query, url (alias uri), headers, body.
+
+## Redact secrets
+
+Commit cassettes without leaking credentials. Redaction runs at record time. The live response your code receives stays intact.
+
+```python
+with use_cassette(
+    "cassettes/api.json",
+    filter_headers=["authorization", "set-cookie"],
+    filter_query_params=["api_key", "token"],
+):
+    ...
+```
+
+Use hooks for full control. Return a changed recording, or return None to skip the recording.
+
+```python
+from dataclasses import replace
+
+def scrub_body(response):
+    return replace(response, body=b'{"token": "REDACTED"}')
+
+with use_cassette("cassettes/api.json", before_record_response=scrub_body):
+    ...
+```
+
+## Cassette format
+
+Cassettes use plain JSON. YAML works with the yaml extra. Both read well in code review.
+
+```json
+{
+  "version": 1,
+  "recorded_with": "replayx/0.1.0",
+  "interactions": [
+    {
+      "request": { "method": "GET", "url": "https://api.example.com/data", "headers": [], "body": null },
+      "response": { "status_code": 200, "headers": [["content-type", "application/json"]], "body": { "text": "{\"ok\":true}" } }
+    }
+  ]
+}
+```
+
+replayx stores binary bodies as base64.
+
+## Contribute
+
+I welcome contributions. Set up a dev environment:
+
+```bash
+git clone https://github.com/mkusiappiah/replayx
+cd replayx
+pip install -e ".[dev]"
+pytest
+ruff check .
+mypy
+```
+
+Open an issue before large changes.
+
+## License
+
+MIT. See [LICENSE](LICENSE).

replayx-0.1.0/pyproject.toml

@@ -0,0 +1,85 @@
+[build-system]
+requires = ["hatchling>=1.18"]
+build-backend = "hatchling.build"
+
+[project]
+name = "replayx"
+dynamic = ["version"]
+description = "Record and replay HTTP interactions for httpx — an async-native VCR for fast, deterministic tests."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { file = "LICENSE" }
+authors = [{ name = "Michael Kusi-Appiah", email = "appiah.michael@yahoo.com" }]
+keywords = [
+    "httpx",
+    "testing",
+    "vcr",
+    "mock",
+    "http",
+    "record",
+    "replay",
+    "pytest",
+    "async",
+    "asyncio",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Framework :: Pytest",
+    "Topic :: Software Development :: Testing",
+    "Topic :: Software Development :: Testing :: Mocking",
+    "Typing :: Typed",
+]
+dependencies = ["httpx>=0.23"]
+
+[project.optional-dependencies]
+yaml = ["PyYAML>=6.0"]
+dev = [
+    "pytest>=7.4",
+    "pytest-asyncio>=0.23",
+    "PyYAML>=6.0",
+    "ruff>=0.5",
+    "mypy>=1.8",
+    "types-PyYAML",
+]
+
+[project.urls]
+Homepage = "https://github.com/mkusiappiah/replayx"
+Repository = "https://github.com/mkusiappiah/replayx"
+Issues = "https://github.com/mkusiappiah/replayx/issues"
+Changelog = "https://github.com/mkusiappiah/replayx/blob/main/CHANGELOG.md"
+
+[project.entry-points.pytest11]
+replayx = "replayx.pytest_plugin"
+
+[tool.hatch.version]
+path = "src/replayx/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/replayx"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/replayx", "tests", "README.md", "CHANGELOG.md", "LICENSE"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]
+
+[tool.mypy]
+strict = true
+files = ["src/replayx"]

replayx-0.1.0/src/replayx/__init__.py

@@ -0,0 +1,33 @@
+"""replayx — record & replay HTTP interactions for httpx.
+
+replayx is an async-native "VCR" for `httpx`: it records real HTTP responses
+to a cassette file the first time your tests run, then replays them on every
+subsequent run so tests are fast, offline and deterministic.
+
+See https://github.com/mkusiappiah/replayx for documentation.
+"""
+
+from __future__ import annotations
+
+__version__ = "0.1.0"
+
+from ._types import RecordMode
+from .cassette import Cassette, Interaction, RecordedRequest, RecordedResponse
+from .errors import CassetteFormatError, ReplayxError, UnhandledRequestError
+from .recorder import use_cassette
+from .transport import AsyncReplayTransport, ReplayTransport
+
+__all__ = [
+    "AsyncReplayTransport",
+    "Cassette",
+    "CassetteFormatError",
+    "Interaction",
+    "RecordMode",
+    "RecordedRequest",
+    "RecordedResponse",
+    "ReplayTransport",
+    "ReplayxError",
+    "UnhandledRequestError",
+    "__version__",
+    "use_cassette",
+]

replayx-0.1.0/src/replayx/_types.py

@@ -0,0 +1,30 @@
+"""Shared types and enumerations for replayx."""
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class RecordMode(str, Enum):
+    """Controls how a cassette records and replays interactions.
+
+    The semantics mirror the well-understood VCR record modes:
+
+    * ``ONCE`` — Replay interactions from an existing cassette. If the cassette
+      file does not yet exist, record everything. Once a cassette exists, new
+      (unmatched) requests raise :class:`~replayx.UnhandledRequestError`.
+    * ``NEW_EPISODES`` — Replay matching interactions and record any new ones,
+      appending them to the cassette.
+    * ``NONE`` — Replay only. Never touch the network and never write. New
+      requests raise :class:`~replayx.UnhandledRequestError`.
+    * ``ALL`` — Never replay. Always hit the real backend and (re)record,
+      overwriting the cassette.
+    """
+
+    ONCE = "once"
+    NEW_EPISODES = "new_episodes"
+    NONE = "none"
+    ALL = "all"
+
+    def __str__(self) -> str:  # pragma: no cover - cosmetic
+        return self.value