Skip to content

Commit c12733a

Browse files
fsecada01claude
andcommitted
docs: update version references and install commands for 0.3.0
- README.md: .[dev,django,websockets] → .[dev] in Quick Start and Development Setup; Requirements section reflects pydantic as the only mandatory dep with optional extras table; test module count 19 → 20; add test_optional_extras.py to project structure; add optional extras entry to Beta roadmap - CLAUDE.md: status 0.2.0-beta → 0.3.0-beta - docs/DJANGO_IMPLEMENTATION.md: install command updated to .[django,websockets,dev-base] - docs/index.html: topbar badge BETA 0.2.0 → BETA 0.3.0 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent aa10ed0 commit c12733a

4 files changed

Lines changed: 17 additions & 17 deletions

File tree

CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Component Framework - AI Development Context
1+
# Component Framework - AI Development Context
22

33
This file provides context for AI assistants working on this project.
44

55
## Project Overview
66

77
**Component Framework** is a Python library for building server-side components with LiveView-style interactivity. It provides a framework-agnostic core with adapters for FastAPI and Django.
88

9-
**Status:** Beta (0.2.0-beta)
9+
**Status:** Beta (0.3.0-beta)
1010
**Language:** Python 3.11+
1111
**License:** MIT
1212

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ git clone https://github.com/fsecada01/component-framework.git
144144
cd component-framework
145145

146146
# Install with uv (recommended)
147-
uv pip install -e ".[dev,django,websockets]"
147+
uv pip install -e ".[dev]"
148148
```
149149

150150
### FastAPI Example
@@ -340,7 +340,7 @@ component-framework/
340340
│ ├── fastapi_example.py # FastAPI demo
341341
│ └── django_example/ # Complete Django app
342342
343-
├── tests/ # 19 test modules
343+
├── tests/ # 20 test modules
344344
│ ├── test_component.py # Core component tests
345345
│ ├── test_form.py # Form validation tests
346346
│ ├── test_registry.py # Registry tests
@@ -358,7 +358,8 @@ component-framework/
358358
│ ├── test_testing_utils.py # Testing utility tests (Beta)
359359
│ ├── test_caching.py # Cache mixin tests (Beta)
360360
│ ├── test_ratelimit.py # Rate limit tests (Beta)
361-
│ └── test_optimistic.py # Optimistic UI tests (Beta)
361+
│ ├── test_optimistic.py # Optimistic UI tests (Beta)
362+
│ └── test_optional_extras.py # Optional extras isolation tests
362363
363364
├── docs/ # Documentation
364365
│ ├── make.py # pdoc build script
@@ -409,7 +410,7 @@ CI runs against Python 3.11, 3.12, 3.13, and 3.14 on every push and pull request
409410
just install # Install all deps (just: https://github.com/casey/just)
410411

411412
# Or manually
412-
uv pip install -e ".[dev,django,websockets]"
413+
uv pip install -e ".[dev]"
413414

414415
just pre-commit-install # Install ruff + ty pre-commit hooks
415416
```
@@ -487,6 +488,7 @@ just claude-prompt PROMPT_FILE=prompts/WORKFLOW.md
487488
- [x] Component composition (slots, composite)
488489
- [x] Testing utilities (`ComponentTestCase`)
489490
- [x] Versioned API documentation (GitHub Pages + pdoc)
491+
- [x] Optional extras — FastAPI/Uvicorn/JinjaX no longer mandatory (`[fastapi]`, `[django]`, `[all]`)
490492

491493
### 1.0 (Planned)
492494
- [ ] Stable, frozen public API
@@ -510,15 +512,13 @@ Current benchmarks (local development):
510512
## Requirements
511513

512514
- Python 3.11+
513-
- FastAPI 0.109+ (FastAPI adapter)
514-
- Django 4.2+ (Django adapter)
515-
- Pydantic 2.0+
516-
517-
Optional:
518-
- Django Channels 4.0+ (WebSocket)
519-
- channels-redis 4.1+ (WebSocket scaling)
520-
- django-cotton 0.9+ (Cotton integration)
521-
- Jinjax 0.41+ (Jinjax rendering)
515+
- Pydantic 2.0+ *(only mandatory runtime dependency)*
516+
517+
Optional extras:
518+
- `[fastapi]` — FastAPI 0.109+, Uvicorn, JinjaX 0.41+
519+
- `[django]` — Django 4.2+, Django Channels 4.0+, channels-redis 4.1+, django-cotton 0.9+
520+
- `[websockets]` — websockets 12.0+
521+
- `[all]` — all of the above
522522

523523
---
524524

docs/DJANGO_IMPLEMENTATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ class CustomerList(Component):
300300
### 1. Install Dependencies
301301

302302
```bash
303-
uv pip install -e ".[django,websockets,dev]"
303+
uv pip install -e ".[django,websockets,dev-base]"
304304
```
305305

306306
### 2. Run Django Example

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -491,7 +491,7 @@
491491
<!-- topbar -->
492492
<header class="topbar">
493493
<a href="index.html" class="topbar__logo">component-framework</a>
494-
<span class="topbar__badge">BETA 0.2.0</span>
494+
<span class="topbar__badge">BETA 0.3.0</span>
495495
<nav aria-label="Top navigation">
496496
<ul class="topbar__links">
497497
<li><a href="index.html">Docs</a></li>

0 commit comments

Comments
 (0)