dbxdebug 0.2.1__tar.gz

dbxdebug-0.2.1/.github/workflows/lint.yml

@@ -0,0 +1,29 @@
+# Lint workflow - runs on every push
+# Checks: ruff, pyright, pre-commit hooks
+
+name: Lint
+
+on:
+  push:
+  workflow_call:  # Allow other workflows to call this
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install uv and set up Python
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: uv sync --locked
+
+      - name: Run pre-commit hooks
+        run: uv run pre-commit run --all-files

dbxdebug-0.2.1/.github/workflows/publish.yml

@@ -0,0 +1,65 @@
+# Publish workflow - runs on v* tags
+# Uses artifacts from test workflow, publishes to PyPI
+#
+# SETUP REQUIRED:
+# 1. Create "pypi" environment in GitHub repo settings
+# 2. Configure PyPI Trusted Publisher at pypi.org
+
+name: Publish
+
+on:
+  push:
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  test:
+    name: Test & Build
+    uses: ./.github/workflows/test.yml
+
+  release:
+    name: Create GitHub Release
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Generate changelog
+        id: changelog
+        uses: requarks/changelog-action@v1
+        with:
+          token: ${{ github.token }}
+          tag: ${{ github.ref_name }}
+
+      - name: Create release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          body: ${{ steps.changelog.outputs.changes }}
+
+  publish:
+    name: Publish to PyPI
+    needs: test
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/dbxdebug
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

dbxdebug-0.2.1/.github/workflows/test.yml

@@ -0,0 +1,73 @@
+# Test workflow - runs on push/PR to main
+# Builds and uploads artifacts for reuse by publish workflow
+
+name: Test
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  workflow_call:
+    outputs:
+      artifact-name:
+        description: "Name of uploaded artifact"
+        value: ${{ jobs.build.outputs.artifact-name }}
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: Lint
+    uses: ./.github/workflows/lint.yml
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    needs: lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install uv and set up Python ${{ matrix.python-version }}
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --locked
+
+      - name: Run tests
+        run: uv run pytest tests -v
+
+  build:
+    name: Build
+    needs: test
+    runs-on: ubuntu-latest
+    outputs:
+      artifact-name: python-package-distributions
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0  # Need full history for hatch-vcs
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v5
+        with:
+          name: python-package-distributions
+          path: dist/
+          retention-days: 1

dbxdebug-0.2.1/.gitignore

@@ -0,0 +1,41 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Type checking
+.mypy_cache/
+.pyright/

dbxdebug-0.2.1/.pre-commit-config.yaml

@@ -0,0 +1,82 @@
+# Pre-commit hooks configuration
+# Install: uv run pre-commit install --install-hooks
+# Install commit-msg hook: uv run pre-commit install --hook-type commit-msg
+# Run manually: uv run pre-commit run --all-files
+
+repos:
+  # Standard pre-commit hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-ast
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-added-large-files
+      - id: debug-statements
+      - id: name-tests-test
+        args: ["--pytest-test-first"]
+
+  # Gitleaks for secret scanning
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.18.4
+    hooks:
+      - id: gitleaks
+
+  # Ruff for linting and formatting
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+      - id: ruff
+        types_or: [python, pyi]
+        args: [--fix]
+      - id: ruff-format
+        types_or: [python, pyi]
+
+  # Pyright for type checking
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.390
+    hooks:
+      - id: pyright
+        additional_dependencies:
+          - click>=8.0
+          - loguru>=0.7
+          - pytest>=7.4.0
+
+  # Pydoclint for docstring linting (Google style)
+  # Disabled for now - too many false positives with internal methods
+  # - repo: https://github.com/jsh9/pydoclint
+  #   rev: 0.5.9
+  #   hooks:
+  #     - id: pydoclint
+  #       args:
+  #         - --style=google
+  #         - --check-return-types=False
+  #         - --arg-type-hints-in-docstring=False
+  #         - --check-class-attributes=False
+  #         - --skip-checking-short-docstrings=False
+  #         - --allow-init-docstring=True
+  #       exclude: ^(tests/|src/dbxdebug/cli\.py)
+
+  # Commitizen for commit message linting (Conventional Commits)
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v3.29.1
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]
+
+  # Actionlint for GitHub Actions workflow linting
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.4
+    hooks:
+      - id: actionlint
+
+  # UV for dependency management - ensures uv.lock is synced
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.7.13
+    hooks:
+      - id: uv-lock

dbxdebug-0.2.1/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: dbxdebug
+Version: 0.2.1
+Summary: Client library and CLI for DOSBox-X remote debug protocols (GDB and QMP)
+Author: lokkju
+License-Expression: MIT
+Keywords: debugging,dosbox,dosbox-x,emulator,gdb,qmp
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Debuggers
+Classifier: Topic :: System :: Emulators
+Requires-Python: >=3.11
+Requires-Dist: click>=8.0
+Requires-Dist: loguru>=0.7
+Description-Content-Type: text/markdown
+
+# dbxdebug
+
+Client library and CLI for DOSBox-X remote debug protocols.
+
+## Features
+
+- **GDB Client**: Remote debugging via GDB Remote Serial Protocol
+  - Memory read/write
+  - Register inspection
+  - Breakpoint management
+  - Execution control (step, continue, halt)
+
+- **QMP Client**: Keyboard input via QEMU Monitor Protocol
+  - Key press/release with timing control
+  - Text typing with shift handling
+  - Key combinations (Ctrl+C, Alt+F4, etc.)
+
+- **Video Tools**: DOS text mode screen capture
+  - Screen capture (text, raw, HTML)
+  - Timed multi-frame recording
+  - Color analysis
+  - BIOS timer correlation
+
+## Installation
+
+```bash
+uv sync
+```
+
+## CLI Usage
+
+```
+dbxdebug
+├── mem              # Memory operations (alias: gdb)
+│   ├── read         # Read memory
+│   └── write        # Write hex bytes
+│
+├── cpu              # CPU and execution control
+│   ├── regs         # Display registers
+│   ├── break        # Set breakpoint
+│   ├── delete       # Remove breakpoint
+│   ├── step         # Single step
+│   ├── cont         # Continue execution
+│   └── halt         # Stop execution
+│
+├── key              # Keyboard input (alias: qmp)
+│   ├── send         # Key chord (e.g., ctrl c)
+│   ├── type         # Type text string
+│   ├── down         # Press and hold key
+│   ├── up           # Release key
+│   └── list         # List QMP commands
+│
+└── screen           # Screen capture
+    ├── show         # Display text to stdout
+    ├── capture      # Save frame to file (-f raw|html|text)
+    ├── record       # Multi-frame timed capture
+    ├── watch        # Real-time display
+    ├── info         # Video mode, BIOS ticks
+    └── colors       # Analyze color palette
+```
+
+### Examples
+
+```bash
+# Memory
+dbxdebug mem read b800:0000 4000 --hex
+dbxdebug mem write 0x1000 90909090
+
+# CPU / Debugging
+dbxdebug cpu regs
+dbxdebug cpu break 0x1000
+dbxdebug cpu step
+dbxdebug cpu cont
+
+# Keyboard
+dbxdebug key send a
+dbxdebug key send ctrl c
+dbxdebug key send ctrl alt delete
+dbxdebug key type "Hello World!"
+
+# Screen
+dbxdebug screen show
+dbxdebug screen capture -f html -o snapshot
+dbxdebug screen record -d 60 -r 30 -o session.capture.gz
+dbxdebug screen watch
+dbxdebug screen colors
+```
+
+## Library Usage
+
+```python
+from dbxdebug import (
+    GDBClient, QMPClient, DOSVideoTools,
+    ScreenRecorder, load_capture,
+    ctrl_key, CTRL_C, DBX_KEY,
+)
+
+# Memory and debugging
+with GDBClient() as gdb:
+    regs = gdb.read_registers()
+    mem = gdb.read_memory("b800:0000", 4000)
+    gdb.write_memory(0x1000, b"\x90\x90")
+    gdb.set_breakpoint(0x1000)
+    gdb.step()
+    gdb.continue_execution()
+
+# Keyboard input
+with QMPClient() as qmp:
+    qmp.send_key(["ctrl", "c"])       # Key chord
+    qmp.send_key(CTRL_C)              # Using constant
+    qmp.type_text("Hello World!")     # Type string
+    qmp.key_down("shift")             # Hold key
+    qmp.key_up("shift")               # Release key
+
+# Screen capture
+with DOSVideoTools() as video:
+    lines = video.screen_dump()           # Text lines
+    raw = video.screen_raw()              # Raw bytes with attrs
+    lines, ticks = video.screen_dump_with_ticks()
+
+# Timed recording
+with DOSVideoTools() as video:
+    recorder = ScreenRecorder()
+    recorder.record(video, duration=10.0, sample_rate=50)
+    recorder.save("session.capture.gz")
+
+# Load and analyze capture
+data = load_capture("session.capture.gz")
+```
+
+## Ports
+
+| Protocol | Default Port | Purpose |
+|----------|--------------|---------|
+| GDB      | 2159         | Debugging, memory access |
+| QMP      | 4444         | Keyboard input |
+
+Enable in DOSBox-X config:
+```ini
+[dosbox]
+gdbserver=true
+qmpserver=true
+```

dbxdebug-0.2.1/README.md

@@ -0,0 +1,143 @@
+# dbxdebug
+
+Client library and CLI for DOSBox-X remote debug protocols.
+
+## Features
+
+- **GDB Client**: Remote debugging via GDB Remote Serial Protocol
+  - Memory read/write
+  - Register inspection
+  - Breakpoint management
+  - Execution control (step, continue, halt)
+
+- **QMP Client**: Keyboard input via QEMU Monitor Protocol
+  - Key press/release with timing control
+  - Text typing with shift handling
+  - Key combinations (Ctrl+C, Alt+F4, etc.)
+
+- **Video Tools**: DOS text mode screen capture
+  - Screen capture (text, raw, HTML)
+  - Timed multi-frame recording
+  - Color analysis
+  - BIOS timer correlation
+
+## Installation
+
+```bash
+uv sync
+```
+
+## CLI Usage
+
+```
+dbxdebug
+├── mem              # Memory operations (alias: gdb)
+│   ├── read         # Read memory
+│   └── write        # Write hex bytes
+│
+├── cpu              # CPU and execution control
+│   ├── regs         # Display registers
+│   ├── break        # Set breakpoint
+│   ├── delete       # Remove breakpoint
+│   ├── step         # Single step
+│   ├── cont         # Continue execution
+│   └── halt         # Stop execution
+│
+├── key              # Keyboard input (alias: qmp)
+│   ├── send         # Key chord (e.g., ctrl c)
+│   ├── type         # Type text string
+│   ├── down         # Press and hold key
+│   ├── up           # Release key
+│   └── list         # List QMP commands
+│
+└── screen           # Screen capture
+    ├── show         # Display text to stdout
+    ├── capture      # Save frame to file (-f raw|html|text)
+    ├── record       # Multi-frame timed capture
+    ├── watch        # Real-time display
+    ├── info         # Video mode, BIOS ticks
+    └── colors       # Analyze color palette
+```
+
+### Examples
+
+```bash
+# Memory
+dbxdebug mem read b800:0000 4000 --hex
+dbxdebug mem write 0x1000 90909090
+
+# CPU / Debugging
+dbxdebug cpu regs
+dbxdebug cpu break 0x1000
+dbxdebug cpu step
+dbxdebug cpu cont
+
+# Keyboard
+dbxdebug key send a
+dbxdebug key send ctrl c
+dbxdebug key send ctrl alt delete
+dbxdebug key type "Hello World!"
+
+# Screen
+dbxdebug screen show
+dbxdebug screen capture -f html -o snapshot
+dbxdebug screen record -d 60 -r 30 -o session.capture.gz
+dbxdebug screen watch
+dbxdebug screen colors
+```
+
+## Library Usage
+
+```python
+from dbxdebug import (
+    GDBClient, QMPClient, DOSVideoTools,
+    ScreenRecorder, load_capture,
+    ctrl_key, CTRL_C, DBX_KEY,
+)
+
+# Memory and debugging
+with GDBClient() as gdb:
+    regs = gdb.read_registers()
+    mem = gdb.read_memory("b800:0000", 4000)
+    gdb.write_memory(0x1000, b"\x90\x90")
+    gdb.set_breakpoint(0x1000)
+    gdb.step()
+    gdb.continue_execution()
+
+# Keyboard input
+with QMPClient() as qmp:
+    qmp.send_key(["ctrl", "c"])       # Key chord
+    qmp.send_key(CTRL_C)              # Using constant
+    qmp.type_text("Hello World!")     # Type string
+    qmp.key_down("shift")             # Hold key
+    qmp.key_up("shift")               # Release key
+
+# Screen capture
+with DOSVideoTools() as video:
+    lines = video.screen_dump()           # Text lines
+    raw = video.screen_raw()              # Raw bytes with attrs
+    lines, ticks = video.screen_dump_with_ticks()
+
+# Timed recording
+with DOSVideoTools() as video:
+    recorder = ScreenRecorder()
+    recorder.record(video, duration=10.0, sample_rate=50)
+    recorder.save("session.capture.gz")
+
+# Load and analyze capture
+data = load_capture("session.capture.gz")
+```
+
+## Ports
+
+| Protocol | Default Port | Purpose |
+|----------|--------------|---------|
+| GDB      | 2159         | Debugging, memory access |
+| QMP      | 4444         | Keyboard input |
+
+Enable in DOSBox-X config:
+```ini
+[dosbox]
+gdbserver=true
+qmpserver=true
+```

dbxdebug-0.2.1/pyproject.toml

@@ -0,0 +1,89 @@
+[project]
+name = "dbxdebug"
+dynamic = ["version"]
+description = "Client library and CLI for DOSBox-X remote debug protocols (GDB and QMP)"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+authors = [
+    { name = "lokkju" }
+]
+keywords = ["dosbox", "dosbox-x", "debugging", "gdb", "qmp", "emulator"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: POSIX",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Debuggers",
+    "Topic :: System :: Emulators",
+]
+dependencies = [
+    "click>=8.0",
+    "loguru>=0.7",
+]
+
+[project.scripts]
+dbxdebug = "dbxdebug.cli:main"
+
+[dependency-groups]
+dev = [
+    "pytest>=7.4.0",
+    "pytest-cov>=4.1.0",
+    "ruff>=0.8.0",
+    "pyright>=1.1.0",
+    "pre-commit>=3.5.0",
+    "commitizen>=3.29.0",
+]
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/dbxdebug"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "UP",  # pyupgrade
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "ARG", # flake8-unused-arguments
+    "SIM", # flake8-simplify
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.pyright]
+include = ["src/dbxdebug", "tests"]
+exclude = [".venv", "**/__pycache__"]
+pythonVersion = "3.11"
+typeCheckingMode = "basic"
+reportMissingTypeStubs = false
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+tag_format = "v$version"
+version_scheme = "pep440"
+version_provider = "scm"  # Read current version from git tags
+major_version_zero = true  # Allow breaking changes in 0.x without major bump
+# Use `cz bump --dry-run` to calculate next version from commits
+# Then `git tag v<version>` - hatch-vcs uses the tag for package version