# Python Replayer Adapter for Temporal
A Python adapter for debugging and replaying Temporal workflows with breakpoint support.
## Features
- **Workflow Debugging**: Comprehensive interceptors for debugging workflow execution
- **Breakpoint Support**: Set breakpoints for standalone mode or integrate with IDE debugger
- **Dual Modes**: Support for both standalone (JSON file) and IDE-integrated replay modes
- **Activity Debugging**: Interceptors for activity execution debugging
## Installation
```bash
# Install in development mode
pip install -e .
# Or install with development dependencies
pip install -e .[dev]
```
## Quick Start
### Standalone Mode
```python
from replayer_adapter_python import *
# Configure replay
set_replay_mode(ReplayMode.STANDALONE)
set_breakpoints([5, 15, 30])
# Replay workflow
opts = ReplayOptions(history_file_path="workflow_history.json")
replay(opts, YourWorkflowClass)
```
### IDE Integration Mode
```python
from replayer_adapter_python import *
# Set IDE mode (connects via WFDBG_HISTORY_PORT env var)
set_replay_mode(ReplayMode.IDE)
# Replay with IDE debugger
opts = ReplayOptions()
replay(opts, YourWorkflowClass)
```
## API Reference
### Core Functions
- `set_replay_mode(mode)`: Set replay mode (`ReplayMode.STANDALONE` or `ReplayMode.IDE`)
- `set_breakpoints(event_ids)`: Set breakpoints for standalone mode
- `replay(opts, workflow_class)`: Main replay function
### Classes
- `ReplayOptions`: Configuration for replay settings
- `RunnerWorkerInterceptor`: Main interceptor for workflow debugging
## Environment Variables
- `WFDBG_HISTORY_PORT`: Port for IDE debugger communication (default: 54578)
## Dependencies
- `temporalio>=1.15.0`
- `requests>=2.32.0`
Raw data
{
"_id": null,
"home_page": null,
"name": "temporal-replayer-adapter-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "temporal, workflow, debugging, replay, interceptor",
"author": null,
"author_email": "Duy Phuong Nguyen <knowledge.phuongnguyen@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/85/bd/e09afd19a25e5f11a8f23de1998b8f0e8a0974d20689a26ae2cd6c3db603/temporal_replayer_adapter_python-1.0.3.tar.gz",
"platform": null,
"description": "# Python Replayer Adapter for Temporal\n\nA Python adapter for debugging and replaying Temporal workflows with breakpoint support.\n\n## Features\n\n- **Workflow Debugging**: Comprehensive interceptors for debugging workflow execution\n- **Breakpoint Support**: Set breakpoints for standalone mode or integrate with IDE debugger\n- **Dual Modes**: Support for both standalone (JSON file) and IDE-integrated replay modes\n- **Activity Debugging**: Interceptors for activity execution debugging\n\n## Installation\n\n```bash\n# Install in development mode\npip install -e .\n\n# Or install with development dependencies\npip install -e .[dev]\n```\n\n## Quick Start\n\n### Standalone Mode\n\n```python\nfrom replayer_adapter_python import *\n\n# Configure replay\nset_replay_mode(ReplayMode.STANDALONE)\nset_breakpoints([5, 15, 30])\n\n# Replay workflow\nopts = ReplayOptions(history_file_path=\"workflow_history.json\")\nreplay(opts, YourWorkflowClass)\n```\n\n### IDE Integration Mode\n\n```python\nfrom replayer_adapter_python import *\n\n# Set IDE mode (connects via WFDBG_HISTORY_PORT env var)\nset_replay_mode(ReplayMode.IDE)\n\n# Replay with IDE debugger\nopts = ReplayOptions()\nreplay(opts, YourWorkflowClass)\n```\n\n## API Reference\n\n### Core Functions\n\n- `set_replay_mode(mode)`: Set replay mode (`ReplayMode.STANDALONE` or `ReplayMode.IDE`)\n- `set_breakpoints(event_ids)`: Set breakpoints for standalone mode\n- `replay(opts, workflow_class)`: Main replay function\n\n### Classes\n\n- `ReplayOptions`: Configuration for replay settings\n- `RunnerWorkerInterceptor`: Main interceptor for workflow debugging\n\n## Environment Variables\n\n- `WFDBG_HISTORY_PORT`: Port for IDE debugger communication (default: 54578)\n\n## Dependencies\n\n- `temporalio>=1.15.0`\n- `requests>=2.32.0` \n",
"bugtrack_url": null,
"license": null,
"summary": "Python Replayer Adapter for Temporal workflows with debugging capabilities",
"version": "1.0.3",
"project_urls": {
"Documentation": "https://github.com/phuongdnguyen/temporal-workflow-replay-debugger/blob/main/replayer-adapter-python/README.md",
"Homepage": "https://github.com/phuongdnguyen/temporal-workflow-replay-debugger",
"Issues": "https://github.com/phuongdnguyen/temporal-workflow-replay-debugger/issues",
"Repository": "https://github.com/phuongdnguyen/temporal-workflow-replay-debugger"
},
"split_keywords": [
"temporal",
" workflow",
" debugging",
" replay",
" interceptor"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d156fd6e264863e0b7c1b8ff1fec99d40b6c290bae797c9bce6fa01410af83f9",
"md5": "cba83ca83e923ae66eb817756ecbeceb",
"sha256": "aab62746724f4b53dc983bd2a37846a06ad6eaec1043cf81f655b091e32bcf75"
},
"downloads": -1,
"filename": "temporal_replayer_adapter_python-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cba83ca83e923ae66eb817756ecbeceb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10526,
"upload_time": "2025-08-23T05:03:25",
"upload_time_iso_8601": "2025-08-23T05:03:25.529555Z",
"url": "https://files.pythonhosted.org/packages/d1/56/fd6e264863e0b7c1b8ff1fec99d40b6c290bae797c9bce6fa01410af83f9/temporal_replayer_adapter_python-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "85bde09afd19a25e5f11a8f23de1998b8f0e8a0974d20689a26ae2cd6c3db603",
"md5": "065619e4edfaaf4a9b551c4326775461",
"sha256": "9ee9f9890f5a060ce65d237c373ef152489bc356d835ee8ef4d35d4096497ea4"
},
"downloads": -1,
"filename": "temporal_replayer_adapter_python-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "065619e4edfaaf4a9b551c4326775461",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12353,
"upload_time": "2025-08-23T05:03:26",
"upload_time_iso_8601": "2025-08-23T05:03:26.629211Z",
"url": "https://files.pythonhosted.org/packages/85/bd/e09afd19a25e5f11a8f23de1998b8f0e8a0974d20689a26ae2cd6c3db603/temporal_replayer_adapter_python-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-23 05:03:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "phuongdnguyen",
"github_project": "temporal-workflow-replay-debugger",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "temporal-replayer-adapter-python"
}
JSON
