roboharness 0.1.1__tar.gz

roboharness-0.1.1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug Report
+about: Report a bug in Roboharness
+title: "[Bug] "
+labels: bug
+assignees: ''
+---
+
+## Description
+
+A clear description of the bug.
+
+## Environment
+
+- OS:
+- Python version:
+- Roboharness version:
+- Simulator (MuJoCo/Isaac Lab/ManiSkill/etc.):
+- Simulator version:
+
+## Steps to Reproduce
+
+1.
+2.
+3.
+
+## Expected Behavior
+
+What you expected to happen.
+
+## Actual Behavior
+
+What actually happened. Include error messages/tracebacks if applicable.
+
+## Additional Context
+
+Any other relevant information (screenshots, logs, etc.)

roboharness-0.1.1/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature Request
+about: Suggest a new feature or improvement
+title: "[Feature] "
+labels: enhancement
+assignees: ''
+---
+
+## Problem
+
+What problem does this feature solve?
+
+## Proposed Solution
+
+Describe the solution you'd like.
+
+## Use Case
+
+How would you use this feature? Include code examples if helpful.
+
+## Alternatives Considered
+
+Any alternative approaches you've thought about.
+
+## Additional Context
+
+Any other relevant information.

roboharness-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,89 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: pip install ruff
+      - name: Ruff lint
+        run: ruff check .
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install package with dev dependencies
+        run: pip install -e ".[dev]"
+      - name: Run tests
+        run: pytest
+
+  mujoco-example:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install system dependencies (OSMesa for headless rendering)
+        run: sudo apt-get update && sudo apt-get install -y libosmesa6-dev
+
+      - name: Install package with MuJoCo backend
+        run: pip install -e ".[mujoco]" Pillow
+
+      - name: Run MuJoCo grasp example
+        env:
+          MUJOCO_GL: osmesa
+        run: python examples/mujoco_grasp.py --report --output-dir ./harness_output
+
+      - name: Upload visual artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: mujoco-grasp-output
+          path: |
+            harness_output/report.html
+            harness_output/mujoco_grasp/trial_001/**/*_rgb.png
+            harness_output/mujoco_grasp/trial_001/**/metadata.json
+          retention-days: 30
+
+      - name: Post summary with checkpoint images
+        run: |
+          echo "## MuJoCo Grasp Example Results" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "Checkpoint captures from the scripted grasp sequence:" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          for cp in harness_output/mujoco_grasp/trial_001/*/; do
+            name=$(basename "$cp")
+            echo "### ${name}" >> $GITHUB_STEP_SUMMARY
+            echo "" >> $GITHUB_STEP_SUMMARY
+            # Embed front view as base64 in summary
+            if [ -f "${cp}front_rgb.png" ]; then
+              echo "![${name} front view](data:image/png;base64,$(base64 -w0 "${cp}front_rgb.png"))" >> $GITHUB_STEP_SUMMARY
+            fi
+            if [ -f "${cp}metadata.json" ]; then
+              step=$(python3 -c "import json; print(json.load(open('${cp}metadata.json'))['step'])")
+              sim_time=$(python3 -c "import json; print(f\"{json.load(open('${cp}metadata.json'))['sim_time']:.3f}\")")
+              echo "" >> $GITHUB_STEP_SUMMARY
+              echo "Step: ${step} | Sim time: ${sim_time}s" >> $GITHUB_STEP_SUMMARY
+            fi
+            echo "" >> $GITHUB_STEP_SUMMARY
+          done
+          echo "---" >> $GITHUB_STEP_SUMMARY
+          echo "Download the full artifact (including HTML report) from the Actions tab." >> $GITHUB_STEP_SUMMARY

roboharness-0.1.1/.github/workflows/pages.yml

@@ -0,0 +1,68 @@
+name: Deploy Visual Report to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install system dependencies (OSMesa for headless rendering)
+        run: sudo apt-get update && sudo apt-get install -y libosmesa6-dev
+
+      - name: Install package with MuJoCo backend
+        run: pip install -e ".[mujoco]" Pillow
+
+      - name: Run MuJoCo grasp example
+        env:
+          MUJOCO_GL: osmesa
+        run: python examples/mujoco_grasp.py --report --output-dir ./harness_output
+
+      - name: Build Pages site
+        run: |
+          mkdir -p _site
+
+          # Copy the HTML report
+          cp harness_output/report.html _site/index.html
+
+          # Copy all checkpoint images (flat structure for easy linking)
+          for cp_dir in harness_output/mujoco_grasp/trial_001/*/; do
+            cp_name=$(basename "$cp_dir")
+            mkdir -p "_site/${cp_name}"
+            cp "${cp_dir}"*_rgb.png "_site/${cp_name}/" 2>/dev/null || true
+            cp "${cp_dir}"*_depth_viz.png "_site/${cp_name}/" 2>/dev/null || true
+            cp "${cp_dir}"metadata.json "_site/${cp_name}/" 2>/dev/null || true
+            cp "${cp_dir}"state.json "_site/${cp_name}/" 2>/dev/null || true
+          done
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: _site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

roboharness-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,130 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - release
+  workflow_dispatch:
+    inputs:
+      bump:
+        description: "Version bump type"
+        required: true
+        default: "patch"
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+      custom_tag:
+        description: "Custom tag (e.g. v1.2.3). Leave empty to auto-bump."
+        required: false
+        type: string
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Determine new version
+        id: version
+        run: |
+          # Read version from pyproject.toml as source of truth
+          CURRENT=$(grep '^version = ' pyproject.toml | sed 's/version = "\(.*\)"/\1/')
+          echo "Current version in pyproject.toml: ${CURRENT}"
+
+          # Get latest semver tag
+          LATEST=$(git tag --sort=-v:refname | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' | head -1)
+          echo "Latest tag: ${LATEST:-none}"
+
+          # For workflow_dispatch with custom_tag
+          if [ -n "${{ inputs.custom_tag }}" ]; then
+            NEW_TAG="${{ inputs.custom_tag }}"
+            NEW_VERSION="${NEW_TAG#v}"
+          # For workflow_dispatch with bump
+          elif [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            if [ -z "$LATEST" ]; then
+              LATEST="v0.0.0"
+            fi
+            VERSION="${LATEST#v}"
+            IFS='.' read -r MAJOR MINOR PATCH <<< "$VERSION"
+
+            case "${{ inputs.bump }}" in
+              major) MAJOR=$((MAJOR + 1)); MINOR=0; PATCH=0 ;;
+              minor) MINOR=$((MINOR + 1)); PATCH=0 ;;
+              patch) PATCH=$((PATCH + 1)) ;;
+            esac
+
+            NEW_VERSION="${MAJOR}.${MINOR}.${PATCH}"
+            NEW_TAG="v${NEW_VERSION}"
+          # For push to release branch: use pyproject.toml version directly
+          else
+            NEW_VERSION="${CURRENT}"
+            NEW_TAG="v${NEW_VERSION}"
+          fi
+
+          # Check if tag already exists
+          if git rev-parse "refs/tags/${NEW_TAG}" >/dev/null 2>&1; then
+            echo "::error::Tag ${NEW_TAG} already exists. Update the version in pyproject.toml before releasing."
+            exit 1
+          fi
+
+          echo "new_tag=${NEW_TAG}" >> "$GITHUB_OUTPUT"
+          echo "new_version=${NEW_VERSION}" >> "$GITHUB_OUTPUT"
+          echo "New release: ${NEW_TAG}"
+
+      - name: Update pyproject.toml version if needed
+        run: |
+          sed -i "s/^version = \".*\"/version = \"${{ steps.version.outputs.new_version }}\"/" pyproject.toml
+          echo "pyproject.toml version:"
+          grep '^version' pyproject.toml
+
+      - name: Commit version bump if needed
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add pyproject.toml
+          if git diff --cached --quiet; then
+            echo "No version change needed"
+          else
+            git commit -m "release: bump version to ${{ steps.version.outputs.new_version }}"
+            git push
+          fi
+
+      - name: Create and push tag
+        run: |
+          git tag "${{ steps.version.outputs.new_tag }}"
+          git push origin "${{ steps.version.outputs.new_tag }}"
+          echo "Created and pushed tag: ${{ steps.version.outputs.new_tag }}"
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create "${{ steps.version.outputs.new_tag }}" \
+            --title "${{ steps.version.outputs.new_tag }}" \
+            --generate-notes
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build package
+        run: |
+          pip install build
+          python -m build
+
+      - name: Verify package
+        run: |
+          pip install dist/*.whl
+          python -c "import roboharness; print('Install OK')"
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

roboharness-0.1.1/.gitignore

@@ -0,0 +1,34 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+htmlcov/
+.coverage
+
+# Harness output (don't commit captured data)
+harness_output/
+checkpoints/
+
+# OS
+.DS_Store
+Thumbs.db

roboharness-0.1.1/CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing to Roboharness
+
+Thank you for your interest in contributing! Roboharness is in early development and we welcome contributions of all kinds.
+
+## How to Contribute
+
+### Reporting Bugs
+
+- Open an issue on [GitHub Issues](https://github.com/MiaoDX/RobotHarness/issues)
+- Include your Python version, OS, and simulator versions
+- Provide a minimal reproducible example if possible
+
+### Suggesting Features
+
+- Open a feature request issue
+- Describe the use case and why it would be useful
+- If you have a design in mind, share it — we appreciate thoughtful proposals
+
+### Submitting Code
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/your-feature`
+3. Install dev dependencies: `pip install -e ".[dev]"`
+4. Make your changes
+5. Run linting and tests:
+   ```bash
+   ruff check src/ tests/
+   pytest
+   ```
+6. Commit with a clear message
+7. Open a Pull Request
+
+### Adding a New Simulator Backend
+
+We especially welcome new simulator backends! To add one:
+
+1. Create a new file in `src/roboharness/backends/`
+2. Implement the `SimulatorBackend` protocol (see `core/harness.py`)
+3. Add an example in `examples/`
+4. Add the simulator's dependencies to `pyproject.toml` as an optional dependency group
+
+### Code Style
+
+- We use [ruff](https://docs.astral.sh/ruff/) for linting and formatting
+- Type hints are encouraged (Python 3.10+ style)
+- Keep it simple — avoid unnecessary abstractions
+
+## Development Setup
+
+```bash
+git clone https://github.com/MiaoDX/RobotHarness.git
+cd RobotHarness
+pip install -e ".[dev]"
+```
+
+## AI Agent Contributions
+
+We actively welcome contributions from AI coding agents! If you're using [Claude Code](https://docs.anthropic.com/en/docs/claude-code), [OpenAI Codex](https://github.com/openai/codex), [OpenClaw](https://github.com/openclaw/openclaw), or other autonomous coding tools to contribute, go for it — just make sure the tests pass.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.

roboharness-0.1.1/LICENSE

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