rich-stepper 0.1.0__tar.gz

rich_stepper-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install uv
+        run: pip install uv
+      - name: Install dependencies
+        run: uv sync --group dev
+      - name: Run tests
+        run: uv run pytest tests/ -v
+
+  build:
+    name: Build package
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install uv
+        run: pip install uv
+      - name: Build sdist and wheel
+        run: uv build
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/

rich_stepper-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,62 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  build:
+    name: Build package
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install uv
+        run: pip install uv
+      - name: Build sdist and wheel
+        run: uv build
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: [build]
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: Create GitHub Release
+    needs: [build]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*

rich_stepper-0.1.0/.gitignore

@@ -0,0 +1,107 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+junit-report.xml
+
+# Translations
+*.mo
+*.pot
+
+# Environments
+.env
+.env.*
+.venv/
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# Ruff
+.ruff_cache/
+
+# Pyright
+pyrightconfig.json
+
+# uv
+.python-version
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Sisyphus
+.sisyphus/

rich_stepper-0.1.0/LICENSE

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

rich_stepper-0.1.0/PKG-INFO

@@ -0,0 +1,366 @@
+Metadata-Version: 2.4
+Name: rich-stepper
+Version: 0.1.0
+Summary: Beautiful multi-step terminal progress widget for Rich. Connected indicators, per-step logging, elapsed timers, and optional progress bars.
+Project-URL: Homepage, https://github.com/abbazs/rich-stepper
+Project-URL: Source, https://github.com/abbazs/rich-stepper
+Project-URL: Issues, https://github.com/abbazs/rich-stepper/issues
+Project-URL: Changelog, https://github.com/abbazs/rich-stepper/releases
+Author-email: Abbas <abbazs@users.noreply.github.com>
+License: MIT
+License-File: LICENSE
+Keywords: cli,progress,rich,stepper,terminal,tui,workflow
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: User Interfaces
+Classifier: Topic :: Terminals
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: rich>=13.0.0
+Provides-Extra: dev
+Requires-Dist: pyright>=1.1.408; extra == 'dev'
+Requires-Dist: pytest>=9.0.2; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# rich-stepper
+
+[![PyPI version](https://img.shields.io/pypi/v/rich-stepper)](https://pypi.org/project/rich-stepper)
+[![Python versions](https://img.shields.io/pypi/pyversions/rich-stepper)](https://pypi.org/project/rich-stepper)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/abbazs/rich-stepper/blob/main/LICENSE)
+
+Beautiful multi-step terminal progress widget for [Rich](https://rich.readthedocs.io/). Connected indicators, per-step logging, elapsed timers, and optional progress bars — all rendered live in your terminal.
+
+## Installation
+
+```
+pip install rich-stepper
+```
+
+Requires Python 3.10+ and [Rich](https://pypi.org/project/rich/) 13+.
+
+## Quick Start
+
+```python
+from rich.console import Console
+from stepper import StepDefinition, StepStatus, Stepper
+
+steps = [
+    StepDefinition("Clone repository", StepStatus.COMPLETED),
+    StepDefinition("Install dependencies", StepStatus.ACTIVE),
+    StepDefinition("Run tests", StepStatus.PENDING),
+    StepDefinition("Deploy", StepStatus.PENDING),
+]
+
+stepper = Stepper(steps=steps)
+Console().print(stepper)
+```
+
+Renders a connected vertical stepper with status indicators:
+
+```
+● Clone repository
+│
+◉ Install dependencies
+│
+○ Run tests
+│
+○ Deploy
+```
+
+## Live Updates
+
+Use the context manager for animated step progression:
+
+```python
+import time
+from stepper import StepDefinition, StepStatus, Stepper
+
+steps = [
+    StepDefinition("Connecting", StepStatus.ACTIVE),
+    StepDefinition("Downloading", StepStatus.PENDING),
+    StepDefinition("Installing", StepStatus.PENDING),
+    StepDefinition("Done", StepStatus.PENDING),
+]
+
+stepper = Stepper(steps=steps)
+with stepper:
+    for i in range(len(steps)):
+        time.sleep(0.5)
+        if i > 0:
+            stepper.set_step_status(i, StepStatus.ACTIVE)
+        time.sleep(0.5)
+        stepper.set_step_status(i, StepStatus.COMPLETED)
+```
+
+## Per-Step Logging
+
+Append log messages to any step with `stepper.log()`:
+
+```python
+from rich.console import Console
+from stepper import StepDefinition, StepStatus, Stepper, StepperTheme
+
+theme = StepperTheme(max_log_rows=3, log_style="dim italic", log_prefix="›")
+
+stepper = Stepper(
+    steps=[
+        StepDefinition("Fetch schema", StepStatus.COMPLETED, step_description="200 OK"),
+        StepDefinition("Migrate database", StepStatus.ACTIVE, step_description="Applying patches…"),
+        StepDefinition("Seed data", StepStatus.PENDING),
+    ],
+    theme=theme,
+    console=Console(),
+    auto_refresh=False,
+)
+
+stepper.log(0, "Connected to postgres://db:5432")
+stepper.log(0, "Fetched 42 table definitions")
+stepper.log(1, "Applying 001_create_users.sql")
+stepper.log(1, "Applying 002_add_indexes.sql")
+stepper.log(1, "Applying 003_seed_config.sql")
+stepper.log(1, "Applying 004_migrate_orders.sql")  # oldest dropped (max_log_rows=3)
+
+Console().print(stepper)
+```
+
+Logs render inline below (or above) each step label. Set `max_log_rows` to cap visible lines, or leave it `None` for terminal-height-aware truncation.
+
+### Log position
+
+Control where logs appear relative to the step label:
+
+```python
+from stepper import LogPosition, StepperTheme
+
+theme = StepperTheme(log_position=LogPosition.ABOVE)  # logs above the label
+```
+
+## Progress Bars
+
+Enable per-step progress bars with `show_bar=True`:
+
+```python
+theme = StepperTheme(show_bar=True, bar_width=20)
+stepper = Stepper(steps=steps, theme=theme, console=Console(), auto_refresh=False)
+stepper.set_step_progress(1, 0.6)  # 60% complete
+Console().print(stepper)
+```
+
+The `percent` argument is clamped to `[0.0, 1.0]`.
+
+## Elapsed Time
+
+Show elapsed time per step:
+
+```python
+theme = StepperTheme(show_elapsed_time=True)
+```
+
+Completed and active steps show elapsed time. Pending steps display `-:--:--`. Time freezes when a step is marked completed.
+
+## Dynamic Steps
+
+Add steps at runtime inside a context manager:
+
+```python
+with Stepper(theme=theme, console=console) as stepper:
+    for url, label in sites:
+        idx = stepper.add_step(label, status=StepStatus.ACTIVE, step_description=url)
+        stepper.log(idx, f"Fetching {url}")
+        # ... do work ...
+        stepper.set_step_status(idx, StepStatus.COMPLETED)
+```
+
+## Theming
+
+`StepperTheme` is a frozen dataclass — set any combination of fields at construction:
+
+### Symbols and styles
+
+```python
+theme = StepperTheme(
+    completed_symbol="✓",
+    active_symbol="◎",
+    pending_symbol="○",
+    completed_style="green bold",
+    active_style="magenta bold",
+    pending_style="bright_black",
+)
+```
+
+### Connectors
+
+```python
+theme = StepperTheme(
+    connector_symbol="│",
+    connector_style="bright_black",
+    line_thickness=2,    # repeat connector symbol N times
+    step_gap=1,          # blank lines between steps
+)
+```
+
+### Label formatting
+
+```python
+theme = StepperTheme(
+    label_style="",
+    step_description_style="dim",
+    label_padding=2,     # spaces before label text
+)
+```
+
+### Progress bar styling
+
+```python
+theme = StepperTheme(
+    show_bar=True,
+    bar_width=20,
+    bar_complete_style="bar.complete",
+    bar_finished_style="bar.finished",
+    bar_pulse_style="bar.pulse",
+)
+```
+
+### Log styling
+
+```python
+from stepper import LogPosition
+
+theme = StepperTheme(
+    log_position=LogPosition.BELOW,  # or LogPosition.ABOVE
+    max_log_rows=5,                  # None for terminal-aware
+    log_style="dim italic",
+    log_prefix="›",
+)
+```
+
+### Time column
+
+```python
+theme = StepperTheme(
+    show_elapsed_time=True,
+    time_style="progress.elapsed",
+)
+```
+
+## API Reference
+
+### `Stepper`
+
+Extends `rich.progress.Progress`. All Progress constructor args are forwarded.
+
+| Method | Description |
+|---|---|
+| `Stepper(steps, theme, console, ...)` | Create stepper with optional initial steps and theme |
+| `add_step(label, status, step_description)` | Add a step, returns `TaskID` |
+| `add_steps(steps)` | Add multiple steps from `StepDefinition` list |
+| `set_step_status(index, status)` | Update step status |
+| `set_step_progress(index, percent)` | Set progress bar (0.0–1.0) |
+| `log(index, message)` | Append a log message to a step |
+
+### `StepStatus`
+
+| Value | Description |
+|---|---|
+| `StepStatus.PENDING` | Not yet started |
+| `StepStatus.ACTIVE` | Currently running |
+| `StepStatus.COMPLETED` | Finished |
+
+### `LogPosition`
+
+| Value | Description |
+|---|---|
+| `LogPosition.BELOW` | Logs render below the step label (default) |
+| `LogPosition.ABOVE` | Logs render above the step label |
+
+### `StepDefinition`
+
+```python
+StepDefinition(label, status=StepStatus.PENDING, step_description=None)
+```
+
+### `StepperTheme`
+
+All fields have sensible defaults. Override any combination:
+
+| Field | Type | Default |
+|---|---|---|
+| `completed_symbol` | `str` | `"●"` |
+| `active_symbol` | `str` | `"◉"` |
+| `pending_symbol` | `str` | `"○"` |
+| `completed_style` | `str` | `"green"` |
+| `active_style` | `str` | `"cyan bold"` |
+| `pending_style` | `str` | `"bright_black"` |
+| `connector_symbol` | `str` | `"│"` |
+| `connector_style` | `str` | `"bright_black"` |
+| `line_thickness` | `int` | `1` |
+| `step_gap` | `int` | `0` |
+| `label_style` | `str` | `""` |
+| `step_description_style` | `str` | `"dim"` |
+| `label_padding` | `int` | `1` |
+| `show_elapsed_time` | `bool` | `False` |
+| `time_style` | `str` | `"progress.elapsed"` |
+| `show_bar` | `bool` | `False` |
+| `bar_width` | `int \| None` | `20` |
+| `bar_complete_style` | `str` | `"bar.complete"` |
+| `bar_finished_style` | `str` | `"bar.finished"` |
+| `bar_pulse_style` | `str` | `"bar.pulse"` |
+| `log_position` | `LogPosition` | `LogPosition.BELOW` |
+| `max_log_rows` | `int \| None` | `None` |
+| `log_style` | `str` | `"dim italic"` |
+| `log_prefix` | `str` | `"›"` |
+
+## Examples
+
+The `examples/` directory contains 17 runnable scripts covering every feature:
+
+| Example | Description |
+|---|---|
+| `01_basic` | Default theme with mixed statuses |
+| `02_custom_colors` | Custom symbol and style colors |
+| `03_emoji_symbols` | Emoji-based step indicators |
+| `04_thick_connectors` | Multi-line connector glyphs |
+| `05_step_gap` | Blank lines between steps |
+| `06_all_completed` | All steps in completed state |
+| `07_in_progress` | Partially completed workflow |
+| `08_minimal_theme` | Stripped-down minimal appearance |
+| `09_dense_layout` | Compact layout with descriptions |
+| `10_many_steps` | Handling 10+ steps |
+| `11_single_step` | Single-step edge case |
+| `12_live_update` | Animated context manager usage |
+| `13_elapsed_time` | Elapsed time column |
+| `14_progress_bar` | Per-step progress bars |
+| `15_step_logging` | Inline log messages |
+| `16_full_featured` | Everything combined |
+| `17_web_scraper` | Real-world web scraper demo |
+
+Run any example directly:
+
+```bash
+python examples/16_full_featured.py
+```
+
+## How It Works
+
+`Stepper` extends Rich's `Progress` class with custom columns:
+
+- **StepIndicatorColumn** — renders status symbols and vertical connectors
+- **StepLabelColumn** — renders labels, descriptions, and inline logs
+- **StepperTimeColumn** — renders elapsed/frozen time per step
+
+Status mapping and log rendering are handled by shared `StatusMapper` and `LogRenderer` helpers for consistency across columns.
+
+## License
+
+[MIT](https://github.com/abbazs/rich-stepper/blob/main/LICENSE)