Skip to content

Add optional dashboard dependencies for flexible installation#14

Merged
skyelaird merged 1 commit intomainfrom
claude/resolve-pr-issues-01KsREzzLyoFtQhiN38RnRBv
Nov 13, 2025
Merged

Add optional dashboard dependencies for flexible installation#14
skyelaird merged 1 commit intomainfrom
claude/resolve-pr-issues-01KsREzzLyoFtQhiN38RnRBv

Conversation

@skyelaird
Copy link
Copy Markdown
Owner

Implemented optional dependencies pattern to allow users to choose between lightweight core library install vs. full dashboard install.

Changes

pyproject.toml:

  • Added [dashboard] optional dependency group with Flask, flask-cors, requests
  • Added [all] group to install everything (dashboard + dev tools)
  • Users can now choose installation scope based on needs

README.md:

  • Updated installation section with 3 clear options:
    • Core library only (lightweight)
    • With dashboard (Flask + UI)
    • Development setup (all tools)
  • Added comparison table showing what's included in each option

Dashboard/README.md:

  • Added recommended installation via main package: pip install -e ".[dashboard]"
  • Kept alternative method (requirements.txt) for reference
  • Fixed step numbering after installation section

Usage

Core library only: pip install -e .
With dashboard: pip install -e ".[dashboard]"
With dev tools: pip install -e ".[dev]"
Everything: pip install -e ".[all]"

This allows developers who only need the propagation engine to avoid unnecessary Flask/web dependencies while dashboard users get everything they need in one command.

Implemented optional dependencies pattern to allow users to choose
between lightweight core library install vs. full dashboard install.

## Changes

**pyproject.toml:**
- Added [dashboard] optional dependency group with Flask, flask-cors, requests
- Added [all] group to install everything (dashboard + dev tools)
- Users can now choose installation scope based on needs

**README.md:**
- Updated installation section with 3 clear options:
  - Core library only (lightweight)
  - With dashboard (Flask + UI)
  - Development setup (all tools)
- Added comparison table showing what's included in each option

**Dashboard/README.md:**
- Added recommended installation via main package: pip install -e ".[dashboard]"
- Kept alternative method (requirements.txt) for reference
- Fixed step numbering after installation section

## Usage

Core library only:     pip install -e .
With dashboard:        pip install -e ".[dashboard]"
With dev tools:        pip install -e ".[dev]"
Everything:            pip install -e ".[all]"

This allows developers who only need the propagation engine to avoid
unnecessary Flask/web dependencies while dashboard users get everything
they need in one command.
@skyelaird skyelaird merged commit c0b9cec into main Nov 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants