Name | IORecorder JSON |
Version |
0.2.0
JSON |
| download |
home_page | None |
Summary | A Python library for recording I/O interactions (keyboard, mouse, and screen). |
upload_time | 2025-01-29 01:07:26 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.7 |
license | MIT |
keywords |
input
output
recording
i/o
keyboard
mouse
screen
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# IORecorder
A Python library for recording screen, mouse, and keyboard interactions with debug video overlay capabilities.
## Installation
```bash
pip install iorecorder
```
## Quick Start
```python
from iorecorder import IORecorder
recorder = IORecorder(output_dir="my_recordings")
recorder.start()
# ... do something, maybe time.sleep() ...
recorder.stop()
```
The recorder will create a timestamped directory containing:
- `screen.mp4`: Screen recording with mouse cursor
- `mouse_events.csv`: Mouse movements, clicks and scrolls
- `keyboard_events.csv`: Keyboard press/release events
## Debug Video Generation
Create a video with overlaid debug information, similar to a minecraft debug log, showing timestamp, mouse coordinates, and currently pressed keys or mouse buttons.
```python
from iorecorder import generate_debug_video
generate_debug_video(
input_mp4="path/to/screen.mp4",
mouse_csv="path/to/mouse_events.csv",
keyboard_csv="path/to/keyboard_events.csv",
output_mp4="path/to/generated_debug_video.mp4"
)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "IORecorder",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "input, output, recording, I/O, keyboard, mouse, screen",
"author": null,
"author_email": "Emericen <yuedilia@usc.edu>",
"download_url": "https://files.pythonhosted.org/packages/3c/7a/75ab05f4f705c9ab24aada07c26af227a43628d405586d993ca37b2e4360/iorecorder-0.2.0.tar.gz",
"platform": null,
"description": "# IORecorder\nA Python library for recording screen, mouse, and keyboard interactions with debug video overlay capabilities.\n\n## Installation\n\n```bash\npip install iorecorder\n```\n\n## Quick Start\n\n```python\nfrom iorecorder import IORecorder\n\nrecorder = IORecorder(output_dir=\"my_recordings\")\nrecorder.start()\n\n# ... do something, maybe time.sleep() ...\n\nrecorder.stop()\n```\nThe recorder will create a timestamped directory containing:\n- `screen.mp4`: Screen recording with mouse cursor\n- `mouse_events.csv`: Mouse movements, clicks and scrolls\n- `keyboard_events.csv`: Keyboard press/release events\n\n## Debug Video Generation\n\nCreate a video with overlaid debug information, similar to a minecraft debug log, showing timestamp, mouse coordinates, and currently pressed keys or mouse buttons.\n\n```python\nfrom iorecorder import generate_debug_video\n\ngenerate_debug_video(\n input_mp4=\"path/to/screen.mp4\",\n mouse_csv=\"path/to/mouse_events.csv\",\n keyboard_csv=\"path/to/keyboard_events.csv\",\n output_mp4=\"path/to/generated_debug_video.mp4\"\n)\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python library for recording I/O interactions (keyboard, mouse, and screen).",
"version": "0.2.0",
"project_urls": {
"Issues": "https://github.com/Emericen/IORecorder/issues",
"Source": "https://github.com/Emericen/IORecorder"
},
"split_keywords": [
"input",
" output",
" recording",
" i/o",
" keyboard",
" mouse",
" screen"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0bdd395cac298fd9486481ff6eb419b8c1232bbbf307edf1bd88cb5ecc73db6c",
"md5": "a28b6befc5fb9dc1de7266b7b9a3349b",
"sha256": "c9af808af74d743e2809d0b10e54814f6e867243a79dce7ebdbc662bff014d3c"
},
"downloads": -1,
"filename": "IORecorder-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a28b6befc5fb9dc1de7266b7b9a3349b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6583,
"upload_time": "2025-01-29T01:07:25",
"upload_time_iso_8601": "2025-01-29T01:07:25.189212Z",
"url": "https://files.pythonhosted.org/packages/0b/dd/395cac298fd9486481ff6eb419b8c1232bbbf307edf1bd88cb5ecc73db6c/IORecorder-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3c7a75ab05f4f705c9ab24aada07c26af227a43628d405586d993ca37b2e4360",
"md5": "2782920f50f1b1a5e0ed0c65cbd8dd0d",
"sha256": "5219820781e0ea285b162f9248bd3a29efd0a40a46ed7e6a650d4d4390f7639f"
},
"downloads": -1,
"filename": "iorecorder-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "2782920f50f1b1a5e0ed0c65cbd8dd0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 6192,
"upload_time": "2025-01-29T01:07:26",
"upload_time_iso_8601": "2025-01-29T01:07:26.195350Z",
"url": "https://files.pythonhosted.org/packages/3c/7a/75ab05f4f705c9ab24aada07c26af227a43628d405586d993ca37b2e4360/iorecorder-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-29 01:07:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Emericen",
"github_project": "IORecorder",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "iorecorder"
}