fast-rich 0.3.0__tar.gz

fast_rich-0.3.0/.agent/workflows/benchmarking.md

@@ -0,0 +1,23 @@
+---
+description: detailed workflow for benchmarking code including versioning and report generation
+---
+
+1.  **Setup & Versioning**:
+    *   **Never Overwrite**: Always create a new versioned entry in `benchmarks/results/<lang>/<version>/`.
+    *   Use `scripts/benchmark_runner.py` to ensure consistency.
+    *   Ensure `benchmarks/requirements.txt` (if Python) is up to date.
+
+2.  **Execution steps**:
+    *   **Baseline**: If optimizing, establish a baseline vX.Y.Z-baseline first.
+    *   **Run**: Execute benchmarks targeting the specific component.
+    *   **Commit**: `git add benchmarks/results/... && git commit -m "bench: record baseline for <feature>"`
+
+3.  **Analysis**:
+    *   Compare new JSON against baseline JSON.
+    *   **Optimization Validated**: If speedup > 5%, document in `CHANGELOG.md`.
+    *   **Regression Check**: If slowdown > 5%, **STOP** and investigate.
+
+4.  **Reporting**:
+    *   Update `docs/benchmarks.md` with new summary tables.
+    *   Update `RICH_RUST_PLAN.md` with the latest result path.
+    *   **Commit**: `git commit -m "docs: update benchmark report"`

fast_rich-0.3.0/.agent/workflows/coding.md

@@ -0,0 +1,31 @@
+---
+description: detailed workflow for coding tasks ensuring high quality, atomic commits, and stability
+---
+
+When asking to write code or implement features, strictly follow this workflow:
+
+1.  **Analyze and Plan**:
+    *   Understand the requirements deeply.
+    *   Check `RICH_RUST_PLAN.md` for context.
+    *   If complex, create an `implementation_plan.md` first.
+
+2.  **Implementation Loop (Per Feature)**:
+    *   **Atomic Scope**: Work on one small, verifiable feature at a time.
+    *   **Test-Driven**: Write tests *alongside* the code.
+    *   **Verify**: Run `cargo check` and `cargo test` immediately.
+    *   **Lint**: Run `cargo clippy` and `cargo fmt --all`.
+    *   **Strict Check**: You MUST run `cargo fmt --all -- --check` to verify CI compliance.
+    *   **Commit**: **IMMEDIATELY** add and commit verification passes.
+        *   Command: `git add <files> && git commit -m "feat: <concise description>"`
+        *   *Never accumulate multiple features in one uncommitted state.*
+
+3.  **Refactor & Polish**:
+    *   Review API ergonomics (Builders, specific types).
+    *   Ensure no `unsafe` unless strictly documented and necessary.
+    *   **Commit**: `git commit -m "refactor: <description>"`
+
+4.  **Final Verification**:
+    *   Run full suite: `cargo test --workspace`.
+    *   Check examples: Run a relevant example from `examples/`.
+
+**Rule of Thumb**: If you have written >50 lines of code without a commit, you are doing it wrong.

fast_rich-0.3.0/.agent/workflows/debugging.md

@@ -0,0 +1,19 @@
+---
+description: workflow for fixing bugs and issues
+---
+
+1.  **Reproduce**:
+    *   Create a minimal reproduction code snippet.
+    *   Create a new test case in a `tests/` file that fails (demonstrates the bug).
+
+2.  **Diagnose**:
+    *   Use logging (`trace!`, `debug!`) or `inspect!` to trace execution.
+    *   Analyze the stack trace if it's a panic.
+
+3.  **Fix**:
+    *   Apply the fix.
+    *   Ensure the reproduction test case now passes.
+
+4.  **Regression Test**:
+    *   Keep the reproduction test in the codebase to prevent regression.
+    *   Run full test suite.

fast_rich-0.3.0/.agent/workflows/documentation.md

@@ -0,0 +1,22 @@
+---
+description: workflow for documentation of the code
+---
+
+1.  **Code Comments**:
+    *   Ensure all public items (structs, enums, functions, traits) have `///` doc comments.
+    *   Use sections in doc comments: `# Examples`, `# Panics`, `# Errors`.
+
+2.  **Generate Docs**:
+    *   Run `cargo doc --no-deps --open` to preview documentation.
+    *   Check for broken links.
+
+3.  **Project Docs**:
+    *   Maintain `README.md` with:
+        *   Project overview
+        *   Installation instructions
+        *   Quick start examples
+        *   Feature list
+    *   Maintain `CHANGELOG.md`.
+
+4.  **Examples**:
+    *   Ensure `examples/` directory contains runnable code demonstrating features.

fast_rich-0.3.0/.agent/workflows/maintenance.md

@@ -0,0 +1,14 @@
+---
+description: workflow for maintaining dependencies and cleanup
+---
+
+1.  **Check Outdated Dependencies**:
+    *   Run `cargo outdated` (requires `cargo-outdated`) or check crates.io manually.
+    *   Update minimal versions in `Cargo.toml` if necessary (e.g. for security fixes).
+
+2.  **Update Lockfile**:
+    *   Run `cargo update` to update `Cargo.lock` within compatible semver ranges.
+    *   Run tests (`cargo test --all-features`) immediately after updating.
+
+3.  **Clean Build Artifacts**:
+    *   Run `cargo clean` occasionally to free disk space or resolve weird build errors.

fast_rich-0.3.0/.agent/workflows/publishing.md

@@ -0,0 +1,29 @@
+---
+description: strict workflow for publishing releases to crates.io and PyPI
+---
+
+1.  **Pre-Release Check**:
+    *   **Tests**: `cargo test --workspace` MUST pass.
+    *   **Lints**: `cargo clippy --workspace -- -D warnings` MUST be clean.
+    *   **Docs**: `cargo doc --no-deps` MUST succeed.
+    *   **Clean Git**: `git status` MUST be clean.
+
+2.  **Versioning**:
+    *   Bump version in `Cargo.toml`.
+    *   Bump version in `bindings/python/Cargo.toml`.
+    *   Update `CHANGELOG.md` with release notes and date.
+    *   **Commit**: `git commit -am "chore: release vX.Y.Z"`
+
+3.  **Dry Run**:
+    *   `cargo publish --dry-run`
+    *   `maturin build` (ensure wheels generated)
+
+4.  **Release Interaction**:
+    *   **ASK USER** for confirmation to publish.
+    *   On approval:
+        1.  `cargo publish`
+        2.  `git tag vX.Y.Z`
+        3.  `git push origin vX.Y.Z`
+
+5.  **Post-Release**:
+    *   Update `RICH_RUST_PLAN.md` start next iteration.

fast_rich-0.3.0/.agent/workflows/reviewing.md

@@ -0,0 +1,27 @@
+---
+description: workflow for reviewing code quality, correctness, and enforcing professional standards
+---
+
+When asked to review code:
+
+1.  **Strict Linting & Formatting**:
+    *   **Format**: Run `cargo fmt --all`.
+    *   **CI Compliance**: Run `cargo fmt --all -- --check` to guarantee CI passes.
+    *   **Lint**: Run `cargo clippy --workspace -- -D warnings`.
+    *   **Commit Fixes**: If the review triggers changes, `git commit -m "style: apply review fixes"` immediately.
+
+2.  **Safety Logic**:
+    *   **Unsafe Audit**: Grep for `unsafe`. If found, it MUST have a `// SAFETY:` comment explaining why it holds.
+    *   **Error Handling**: No `unwrap()` in `src/` (library code). Use `?` and custom errors.
+    *   **Public API**: Ensure all `pub` items have doc strings.
+
+3.  **Test Coverage**:
+    *   Run `cargo test --workspace`.
+    *   If a bug is found, write a reproduction test case *first*.
+
+4.  **Documentation**:
+    *   Check `README.md` and `CHANGELOG.md` are consistent with the code.
+    *   Ensure `examples/` compile and run.
+
+5.  **Final Polish**:
+    *   Does code look "Professional"? (Consistent naming, no commented-out blocks, no "TODOs" left in critical paths).

fast_rich-0.3.0/.agent/workflows/security.md

@@ -0,0 +1,14 @@
+---
+description: workflow for checking security vulnerabilities
+---
+
+1.  **Vulnerability Scanning**:
+    *   Install `cargo-audit` if not present: `cargo install cargo-audit`.
+    *   Run `cargo audit` to check for specific vulnerabilities in dependencies.
+
+2.  **Unsafe Code Review**:
+    *   Search for `unsafe` blocks: `grep -r "unsafe" src/`.
+    *   Audit each block for soundness and ensure comments explain safety.
+
+3.  **Fuzzing** (Optional):
+    *   Use `cargo-fuzz` for parsing logic (markup, markdown).

fast_rich-0.3.0/.agent/workflows/testing.md

@@ -0,0 +1,20 @@
+---
+description: workflow for testing the library
+---
+
+1.  **Unit Tests**:
+    *   Run `cargo test --lib` to test core logic.
+    *   Ensure all modules have a `#[cfg(test)] mod tests` section.
+
+2.  **Integration Tests**:
+    *   Run integration tests in `tests/` directory (if any) via `cargo test --test '*'`.
+
+3.  **Doc Tests**:
+    *   Run `cargo test --doc` to verify code examples in comments.
+
+4.  **Feature Permutations**:
+    *   Run tests with all features: `cargo test --all-features`.
+    *   Run tests with no features: `cargo test --no-default-features`.
+
+5.  **Visual Verification**:
+    *   Run examples to ensure output looks correct: `cargo run --example <name>`.

fast_rich-0.3.0/.agent/workflows/versioning.md

@@ -0,0 +1,20 @@
+---
+description: workflow for managing code versions and changelog
+---
+
+1.  **Check Current Version**:
+    *   Read `Cargo.toml` [package] section.
+
+2.  **Determine Bump Type**:
+    *   **Major**: Breaking API changes.
+    *   **Minor**: New features, backwards compatible.
+    *   **Patch**: Bug fixes, backwards compatible.
+
+3.  **Update Files**:
+    *   Update `version` in `Cargo.toml`.
+    *   Update `CHANGELOG.md` with a new header `[Version] - YYYY-MM-DD`.
+    *   Move "Unreleased" changes to the new version section.
+
+4.  **Tagging (Git)**:
+    *   Create a git commit: `chore: Bump version to X.Y.Z`.
+    *   Create a git tag: `git tag vX.Y.Z`.

fast_rich-0.3.0/.github/workflows/docs.yml

@@ -0,0 +1,47 @@
+name: Docs
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - name: Install dependencies
+        working-directory: bindings/python
+        run: pip install mkdocs-material
+
+      - name: Build documentation
+        working-directory: bindings/python
+        run: mkdocs build
+
+      - name: Deploy documentation
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        working-directory: bindings/python
+        run: mkdocs gh-deploy --force

fast_rich-0.3.0/.github/workflows/rust.yml

@@ -0,0 +1,67 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  test:
+    name: Test Suite
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+      - name: Cache dependencies
+        uses: Swatinem/rust-cache@v2
+      - name: Build
+        run: cargo build --verbose
+      - name: Run tests
+        run: cargo test --all-features --verbose
+
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy
+      - name: Cache dependencies
+        uses: Swatinem/rust-cache@v2
+      - name: Lint
+        run: cargo clippy --all-features -- -D warnings
+
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt
+      - name: Check formatting
+        run: cargo fmt --all -- --check
+
+  bindings:
+    name: Python Bindings
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+      - name: Install maturin
+        run: pip install maturin
+      - name: Build bindings
+        working-directory: bindings/python
+        run: maturin build

fast_rich-0.3.0/.gitignore

@@ -0,0 +1,45 @@
+/target
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual Environments
+venv/
+.env
+.venv
+env/
+ENV/
+env.bak/
+venv.bak/
+
+# MkDocs
+site/
+
+# IDE
+.idea/
+.vscode/
+
+# OS
+.DS_Store
+

fast_rich-0.3.0/CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2025-12-30
+
+### Added
+- **Layout**: New tiling layout engine (`Layout`, `split_row`, `split_column`).
+- **Live**: Live display updating (`Live` context manager).
+- **Prompt**: Interactive user input handling (`Prompt.ask`).
+- **Inspect**: Object introspection tool (`inspect()`) for Rust and Python objects.
+- **Filesize**: Utilities for human-readable file sizes (`decimal`, `binary`).
+- **Bindings**: Full Python bindings for all new modules.
+- **Benchmarks**: Comparisons for `Layout` and `Inspect` scenarios.
+- **CI**: Strict enforcing of atomic commits and formatting.
+
+## [0.1.1] - 2025-12-30
+
+### Improved
+- **Syntax Highlighting Performance**: Optimized `Syntax` rendering speed by **3.5x** (14.5s -> 4.2s for 1000 iterations) by using `OnceLock` for global syntax/theme set caching. This resolved a major bottleneck where large binary dumps were reloaded on every instantiation.
+
+## [0.1.0] - 2025-12-30
+
+### Added
+- **Core Library**: Implemented Rust port of Rich's core components:
+  - `Console` with style and color support.
+  - `Table` with auto-sizing and unicode borders.
+  - `Tree` for hierarchical data.
+  - `Panel` and `Rule` layouts.
+  - `Progress` bars with spinners.
+  - `Markdown` rendering via `pulldown-cmark`.
+  - `Syntax` highlighting via `syntect`.
+  - `Traceback` beautiful error reporting.
+  - `Logging` handler.
+- **Python Bindings**: Full ABI3-compatible Python extension module (`rich_rust`) exposing all core components.
+- **Benchmarks**: Comprehensive suite proving 2x-24x performance improvements over Python `rich`.
+  - Logging: 24x faster.
+  - Columns: 23x faster.
+  - Table: 17x faster.
+  - Tree: 11x faster.
+  - Markdown: 9x faster.
+
+### Fixed
+- Fixed duplicate `dev-dependencies` in `Cargo.toml`.
+- Resolved all Clippy warnings in core and bindings.