pyroboreplay 0.2.0__tar.gz → 2.7.0__tar.gz

pyroboreplay-2.7.0/.env.example

@@ -0,0 +1,27 @@
+# API Configuration
+API_KEY=your_api_key_here
+API_SECRET=your_api_secret_here
+
+# Database
+DATABASE_URL=postgresql://user:password@localhost/database_name
+DB_HOST=localhost
+DB_PORT=5432
+DB_USER=user
+DB_PASSWORD=password
+DB_NAME=database
+
+# Security
+SECRET_KEY=your_secret_key_here
+ENCRYPTION_KEY=your_encryption_key_here
+
+# Environment
+ENVIRONMENT=development
+DEBUG=False
+
+# Logging
+LOG_LEVEL=INFO
+LOG_FILE=app.log
+
+# Optional features
+REDIS_URL=redis://localhost:6379
+ELASTICSEARCH_URL=http://localhost:9200

pyroboreplay-2.7.0/.gitattributes

@@ -0,0 +1,42 @@
+# Aggressive language detection: mark everything non-Python as non-detectable
+
+# Hide all C/C++ files
+*.c linguist-detectable=false
+*.h linguist-detectable=false
+*.cpp linguist-detectable=false
+*.cc linguist-detectable=false
+*.cxx linguist-detectable=false
+*.C linguist-detectable=false
+*.c++ linguist-detectable=false
+
+# Hide Rust
+*.rs linguist-detectable=false
+
+# Hide Pawn
+*.pwn linguist-detectable=false
+*.pawn linguist-detectable=false
+
+# Hide Makefiles and build config
+Makefile linguist-detectable=false
+makefile linguist-detectable=false
+*.make linguist-detectable=false
+
+# Hide DTrace
+*.d linguist-detectable=false
+
+# Hide all build/generated artifacts
+build/** linguist-detectable=false
+dist/** linguist-detectable=false
+target/** linguist-detectable=false
+*.so linguist-detectable=false
+*.pyd linguist-detectable=false
+*.dylib linguist-detectable=false
+*.dll linguist-detectable=false
+*.a linguist-detectable=false
+*.o linguist-detectable=false
+
+# Force Python as the ONLY detectable language
+*.py linguist-detectable=true
+*.pyi linguist-detectable=true
+pyproject.toml linguist-detectable=true
+setup.py linguist-detectable=true

pyroboreplay-2.7.0/.github/CI_SETUP.md

@@ -0,0 +1,223 @@
+# GitHub Actions CI/CD Setup
+
+## Overview
+
+Comprehensive CI/CD pipeline for PyRoboReplay with automated testing, linting, building, security audits, and PyPI publishing.
+
+## Workflows
+
+### 1. **ci.yml** - Main Continuous Integration
+
+Runs on every push to `main`, `master`, `develop` and on all pull requests.
+
+**Matrix Testing:**
+- OS: Ubuntu, macOS
+- Rust: stable, beta
+- Python: 3.10, 3.11, 3.12, 3.13
+
+**Jobs:**
+- **Test Suite**: `cargo test --lib --verbose`
+  - Runs on Ubuntu + macOS with latest Rust
+  - Caches dependencies for faster runs
+  - ~2-3 min per matrix combination
+
+- **Lint & Format**: 
+  - `cargo fmt -- --check` (Rustfmt validation)
+  - `cargo clippy --all-targets --all-features -- -D warnings`
+  - Runs on Ubuntu with Rust stable
+  - Treats warnings as errors (strict quality gate)
+
+- **Build Wheels**:
+  - Builds Python wheels using maturin
+  - Matrix: Ubuntu + macOS × Python 3.10-3.13
+  - Uploads wheels as GitHub artifacts for inspection
+  - Validates packaging works across platforms
+
+- **Publish** (conditional):
+  - Only runs on tags matching `refs/tags/v*`
+  - Publishes all wheels to PyPI
+  - Requires `PYPI_TOKEN` secret configured in GitHub
+
+### 2. **security.yml** - Security & Vulnerability Auditing
+
+Runs on every push, pull request, and weekly on schedule (Sunday 00:00 UTC).
+
+**Jobs:**
+- **Cargo Audit**: 
+  - Checks for known security vulnerabilities in dependencies
+  - Uses official RustSec advisory database
+  - Fails if vulnerabilities found (unless whitelisted)
+
+- **Dependency Check**:
+  - Identifies outdated/stale dependencies
+  - Runs `cargo outdated` for visibility
+  - Informational only (doesn't fail)
+
+- **Code Coverage**:
+  - Generates code coverage reports using `cargo-tarpaulin`
+  - Uploads to Codecov for tracking
+  - Timeout: 5 minutes per test
+  - Excludes benchmark code
+
+### 3. **release.yml** - Automated Release Pipeline
+
+Triggered automatically when pushing version tags matching pattern `v*` (e.g., `v0.7.0`).
+
+**Jobs:**
+- **Create GitHub Release**:
+  - Creates a draft release on GitHub with tag info
+  - Outputs upload URL for assets
+
+- **Build & Publish**:
+  - Builds wheels for Python 3.10-3.13 on Ubuntu & macOS
+  - Uploads each wheel as release asset
+  - Automatically publishes to PyPI
+  - Skips duplicates if re-run
+
+**Usage:**
+```bash
+git tag v0.8.0
+git push origin v0.8.0
+# Workflow automatically runs, builds, and publishes
+```
+
+### 4. **docs.yml** - Documentation Validation
+
+Runs on every push to main branches and all PRs.
+
+**Jobs:**
+- **Documentation Build**:
+  - Builds Rust documentation: `cargo doc --no-deps`
+  - Includes private items for complete API docs
+  - Validates all doc comments compile
+
+- **README Validation**:
+  - Checks README.md and CLAUDE.md exist
+  - Runs markdownlint for markdown compliance
+  - Non-blocking (informational only)
+
+## GitHub Secrets Required
+
+### `PYPI_TOKEN` (Required for PyPI Publishing)
+
+1. Generate token at https://pypi.org/manage/account/tokens/
+2. Create token with scope: "Entire account"
+3. Copy token value
+4. In GitHub repo:
+   - Settings → Secrets and variables → Actions
+   - New repository secret
+   - Name: `PYPI_TOKEN`
+   - Value: `pypi-AgEI...` (your token)
+
+**Note:** Token is automatically masked in logs.
+
+## Performance & Caching
+
+**Cargo Caching Strategy:**
+- Registry cache: `~/.cargo/registry`
+- Index cache: `~/.cargo/git`
+- Build cache: `target/` directory
+
+Cache keys use `Cargo.lock` hash to invalidate when dependencies change.
+
+**Build Times (approximate):**
+- Clean build: 2-3 min (Ubuntu), 3-4 min (macOS)
+- Cached build: 30-60 sec
+- Full test suite: 1-2 min
+- Linting: 1-2 min
+
+## Status Badges
+
+Add to README.md:
+
+```markdown
+![CI Status](https://github.com/mullassery/pyroboreplay/actions/workflows/ci.yml/badge.svg)
+![Security Audit](https://github.com/mullassery/pyroboreplay/actions/workflows/security.yml/badge.svg)
+```
+
+## Workflow Status & Logs
+
+View workflow runs:
+- GitHub repo → Actions tab
+- Click workflow name to see runs
+- Click run to see detailed logs
+- Failed jobs show error messages
+
+## Common Issues & Troubleshooting
+
+### Issue: "Clippy warnings treated as errors"
+**Solution:** Fix warnings before pushing. Run locally:
+```bash
+cargo clippy --all-targets --all-features -- -D warnings
+```
+
+### Issue: "Format check failed"
+**Solution:** Auto-format code:
+```bash
+cargo fmt
+git add .
+git commit -m "Format code"
+```
+
+### Issue: "Security vulnerability detected"
+**Solution:** Update affected dependency:
+```bash
+cargo update package-name
+cargo test
+git add Cargo.lock
+git commit -m "Update vulnerable dependency"
+```
+
+### Issue: "PyPI publishing failed"
+**Causes:**
+- `PYPI_TOKEN` not configured in secrets
+- Token expired or revoked
+- Version already published (use `--skip-existing` flag)
+- Package metadata invalid
+
+**Debug:** Check workflow logs in Actions tab.
+
+## Extending Workflows
+
+### Add new test matrix:
+Edit `ci.yml`, add OS/Rust version to matrix:
+```yaml
+strategy:
+  matrix:
+    os: [ubuntu-latest, macos-latest, windows-latest]
+    rust: [stable, beta, nightly]
+```
+
+### Add custom lint rule:
+```yaml
+- name: Custom Linter
+  run: |
+    cargo clippy --all-targets -- -W clippy::pedantic
+```
+
+### Deploy documentation:
+Add step to release workflow to publish docs to GitHub Pages.
+
+## Best Practices
+
+✅ **DO:**
+- Run `cargo test` and `cargo clippy` locally before pushing
+- Test on macOS if targeting Apple Silicon
+- Keep dependencies updated
+- Review security audit results weekly
+- Use meaningful commit messages
+
+❌ **DON'T:**
+- Force-push to main (breaks workflow artifacts)
+- Commit `Cargo.lock` changes carelessly (affects build reproducibility)
+- Ignore security warnings
+- Use `--skip-existing` to hide publishing errors
+- Configure credentials in workflow files (use Secrets)
+
+## References
+
+- [GitHub Actions Documentation](https://docs.github.com/en/actions)
+- [Rust Toolchain GitHub Action](https://github.com/dtolnay/rust-toolchain)
+- [Maturin Documentation](https://maturin.rs/)
+- [PyPI Token Setup](https://pypi.org/help/#apitoken)
+- [RustSec Advisory Database](https://rustsec.org/)

pyroboreplay-2.7.0/.github/workflows/ci.yml

@@ -0,0 +1,125 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master, develop]
+  pull_request:
+    branches: [main, master, develop]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  test:
+    name: Test Suite
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        rust: [stable, beta]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.rust }}
+
+      - name: Cache cargo registry
+        uses: actions/cache@v3
+        with:
+          path: ~/.cargo/registry
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Cache cargo index
+        uses: actions/cache@v3
+        with:
+          path: ~/.cargo/git
+          key: ${{ runner.os }}-cargo-git-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Cache cargo build
+        uses: actions/cache@v3
+        with:
+          path: target
+          key: ${{ runner.os }}-cargo-build-target-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Run tests
+        run: cargo test --lib --verbose
+
+  lint:
+    name: Clippy & Format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt, clippy
+
+      - name: Check formatting
+        run: cargo fmt -- --check
+
+      - name: Run clippy
+        run: cargo clippy --all-targets --all-features -- -D warnings
+
+  build:
+    name: Build Wheel
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install maturin
+        run: pip install maturin
+
+      - name: Build wheel
+        run: maturin build --release
+
+      - name: Upload wheels
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels-${{ matrix.os }}-py${{ matrix.python-version }}
+          path: target/wheels/
+
+  publish:
+    name: Publish to PyPI
+    needs: [test, lint, build]
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install maturin twine
+
+      - name: Build wheels
+        run: maturin build --release
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          twine upload target/wheels/* --skip-existing

pyroboreplay-2.7.0/.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Documentation
+
+on:
+  push:
+    branches: [main, master, develop]
+  pull_request:
+    branches: [main, master, develop]
+
+jobs:
+  docs:
+    name: Build Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Build docs
+        run: cargo doc --no-deps --document-private-items
+
+      - name: Check doc links
+        run: cargo doc --no-deps --document-private-items 2>&1 | grep -E "warning|error" || true
+
+  readme:
+    name: Validate README
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check README exists
+        run: test -f README.md && echo "README.md found"
+
+      - name: Validate markdown
+        run: |
+          pip install markdownlint-cli
+          markdownlint README.md CLAUDE.md || true

pyroboreplay-2.7.0/.github/workflows/release.yml

@@ -0,0 +1,74 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  create-release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    outputs:
+      upload_url: ${{ steps.create_release.outputs.upload_url }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          draft: false
+          prerelease: false
+
+  build-and-publish:
+    name: Build and Publish Wheel
+    needs: create-release
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install maturin
+        run: pip install maturin
+
+      - name: Build wheel
+        run: maturin build --release
+
+      - name: Upload Release Asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.create-release.outputs.upload_url }}
+          asset_path: ./target/wheels/pyroboreplay-*.whl
+          asset_name: pyroboreplay-${{ github.ref }}-${{ matrix.os }}-py${{ matrix.python-version }}.whl
+          asset_content_type: application/zip
+
+      - name: Install dependencies
+        run: pip install twine
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          twine upload target/wheels/pyroboreplay-*.whl --skip-existing

pyroboreplay-2.7.0/.github/workflows/security.yml

@@ -0,0 +1,64 @@
+name: Security Audit
+
+on:
+  push:
+    branches: [main, master, develop]
+  pull_request:
+    branches: [main, master, develop]
+  schedule:
+    # Weekly security audit
+    - cron: '0 0 * * 0'
+
+jobs:
+  audit:
+    name: Cargo Audit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install cargo-audit
+        run: cargo install cargo-audit
+
+      - name: Run security audit
+        run: cargo audit
+
+  dependencies:
+    name: Check Outdated Dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install cargo-outdated
+        run: cargo install cargo-outdated
+
+      - name: Check outdated dependencies
+        run: cargo outdated --format list
+
+  coverage:
+    name: Code Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install tarpaulin
+        run: cargo install cargo-tarpaulin
+
+      - name: Generate coverage
+        run: cargo tarpaulin --out Xml --exclude-files benches/* --timeout 600
+        continue-on-error: true
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          files: ./cobertura.xml
+          fail_ci_if_error: false
+        continue-on-error: true

pyroboreplay-2.7.0/.gitignore

@@ -0,0 +1,43 @@
+# Sensitive files and credentials
+.env
+.env.local
+.env.*.local
+*.key
+*.pem
+*.crt
+credentials.json
+secrets.json
+.credentials
+config.local.*
+.config.local
+oauth_tokens.json
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+*~
+.DS_Store
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+
+# Virtual environments
+venv/
+env/
+.venv
+
+# Rust
+target/
+Cargo.lock
+
+# Temp files
+*.tmp
+*.log
+temp/
+tmp/