shadlet 0.1.1__tar.gz

shadlet-0.1.1/.gitignore

@@ -0,0 +1,119 @@
+# ==========================================
+# Shadlet Monorepo Root .gitignore
+# Python, Node/React, OS
+# ==========================================
+
+# --- Python ---
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.pyd
+*.dll
+*.dylib
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+/lib/
+/lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Virtual environments
+.env
+.env.*
+!.env.example
+.venv
+venv/
+ENV/
+env/
+env.bak/
+venv.bak/
+
+# Python test, coverage & type checking
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+.nox/
+.hypothesis/
+.mypy_cache/
+.ruff_cache/
+
+# --- Node / JavaScript / TypeScript / React ---
+node_modules/
+.npm
+*.tsbuildinfo
+.eslintcache
+.turbo/
+package-lock.json.bak
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Vite / bundler temporary output
+.cache/
+packages/renderer/dist/
+packages/renderer/.vite/
+
+
+
+
+# --- MkDocs & Documentation ---
+site/
+
+# --- OS & Editor Specific ---
+# Windows
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+[Dd]esktop.ini
+$RECYCLE.BIN/
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+*.lnk
+
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon
+._*
+.Spotlight-V100
+.Trashes
+
+# Linux
+*~
+.fuse_hidden*
+.directory
+.Trash-*
+
+# Editors and IDEs
+.idea/
+.vscode/
+*.code-workspace
+*.swp
+*.swo
+*~
+*.bak
+*.sublime-project
+*.sublime-workspace

shadlet-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Soumalya Das and shadlet contributors
+
+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.

shadlet-0.1.1/PKG-INFO

@@ -0,0 +1,263 @@
+Metadata-Version: 2.5
+Name: shadlet
+Version: 0.1.1
+Summary: A Python-first web framework for building beautiful, interactive web applications with genuine shadcn/ui components
+Project-URL: Homepage, https://github.com/programmersd21/shadlet
+Project-URL: Documentation, https://github.com/programmersd21/shadlet#readme
+Project-URL: Repository, https://github.com/programmersd21/shadlet
+Author: shadlet Authors
+License-Expression: MIT
+License-File: LICENSE
+Keywords: framework,react,shadcn,shadcn-ui,ui,web
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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 :: Internet :: WWW/HTTP :: WSGI :: Application
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.11
+Requires-Dist: anyio>=4.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: starlette>=0.30.0
+Requires-Dist: typer>=0.9.0
+Requires-Dist: uvicorn[standard]>=0.20.0
+Requires-Dist: websockets>=12.0
+Provides-Extra: dev
+Requires-Dist: build>=1.0.0; extra == 'dev'
+Requires-Dist: httpx2>=0.28.0; extra == 'dev'
+Requires-Dist: mypy>=1.10.0; extra == 'dev'
+Requires-Dist: pyright>=1.1.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Requires-Dist: twine>=5.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+![banner](https://raw.githubusercontent.com/programmersd21/shadlet/main/community/banner.png)
+
+[![ci](https://img.shields.io/github/actions/workflow/status/programmersd21/shadlet/ci.yml?branch=main&label=ci&style=flat-square)](https://github.com/programmersd21/shadlet/actions/workflows/ci.yml)
+[![docs](https://img.shields.io/github/actions/workflow/status/programmersd21/shadlet/docs.yml?branch=main&label=docs&style=flat-square)](https://github.com/programmersd21/shadlet/actions/workflows/docs.yml)
+[![python](https://img.shields.io/badge/python-3.11%2B-3776ab?style=flat-square&logo=python&logoColor=white)](https://www.python.org/)
+[![license](https://img.shields.io/github/license/programmersd21/shadlet?style=flat-square)](https://github.com/programmersd21/shadlet/blob/main/LICENSE)
+[![pypi](https://img.shields.io/pypi/v/shadlet?style=flat-square)](https://pypi.org/project/shadlet/)
+[![docs site](https://img.shields.io/badge/docs-online-5c4ee5?style=flat-square)](https://programmersd21.github.io/shadlet/)
+
+**python-first web applications with a genuine shadcn/ui renderer.**
+
+</div>
+
+shadlet is a framework that lets developers build modern web applications in python. react renders the interface with authentic shadcn/ui components. python manages application state, events, routing and server-side logic. end users run applications with python only; node.js is only needed to build the renderer.
+
+## showcase
+
+![demo1](https://raw.githubusercontent.com/programmersd21/shadlet/main/community/demo1.png)
+
+## why shadlet
+
+- python developers can build web applications using pure python.
+- the frontend is genuine shadcn/ui (tailwind + base-ui), not an imitation.
+- components are strictly typed and validated across the protocol.
+- reactive session state, async event handlers, and incremental patches.
+
+## comparison
+
+| feature | shadlet | typical python web ui |
+|---|---|---|
+| rendering | react + authentic shadcn/ui | server-rendered templates |
+| state | reactive session state | request/response state |
+| components | 56 built-in shadcn/ui components | custom widget sets |
+| packaging | python wheel with bundled renderer | manual frontend build |
+
+## features
+
+- typed python component api with enums and validation
+- 56 built-in components from shadcn/ui base-vega
+- official bundled geist variable & geist mono typography
+- smooth animations, backdrop blur, and spring physics
+- automatic port switching when default port is occupied
+- hot reload with diff-based patches
+- session-scoped reactive state
+- async event handlers with cancellation
+- versioned json protocol with incremental patches
+- typer and rich cli
+- github project templates
+- mkdocs documentation website
+
+## installation
+
+requirements:
+
+- python 3.11 or newer
+
+node.js is only required for maintainers building the renderer from source.
+
+```bash
+uv pip install -e '.[dev]'
+```
+
+verify:
+
+```bash
+shadlet doctor
+shadlet info
+```
+
+## quick start
+
+create a project:
+
+```bash
+shadlet create my-app
+cd my-app
+shadlet dev
+```
+
+or write `main.py` directly:
+
+```python
+import shadlet as ui
+
+app = ui.App("counter")
+
+
+@app.page("/")
+def home(ctx: ui.Context):
+    count = ctx.state(0, key="count")
+
+    def increment(event: ui.ClickEvent):
+        count.value += 1
+
+    return ui.Center(
+        ui.Column(
+            ui.Heading("counter"),
+            ui.Text(count),
+            ui.Button("increment", on_click=increment),
+            gap=16,
+        ),
+        min_height="100vh",
+    )
+
+
+if __name__ == "__main__":
+    app.run()
+```
+
+run:
+
+```bash
+python main.py
+```
+
+open `http://127.0.0.1:8000`.
+
+![demo2](https://raw.githubusercontent.com/programmersd21/shadlet/main/community/demo2.png)
+
+## architecture
+
+```mermaid
+flowchart LR
+  A[python application] --> B[component api]
+  B --> C[validation and normalisation]
+  C --> D[versioned json protocol]
+  D --> E[react renderer]
+  E --> F[browser]
+```
+
+- python handles application logic.
+- react handles rendering.
+- communication uses a versioned json protocol over websocket.
+
+## project structure
+
+```text
+shadlet/
+  packages/python/shadlet   python runtime
+  packages/renderer         react renderer
+  templates                 project templates
+  examples                  example applications
+  tests                     python tests
+  docs                      documentation
+```
+
+## examples
+
+- `examples/counter` minimal counter
+- `examples/todo` todo list with forms
+- `examples/dashboard` dashboard with charts and tables
+
+run any example:
+
+```bash
+cd examples/counter
+PYTHONPATH=../../packages/python python main.py
+```
+
+## documentation
+
+full documentation is in `docs/` and built with mkdocs.
+
+```bash
+python -m mkdocs serve
+python -m mkdocs build --strict
+```
+
+## development
+
+clone and set up:
+
+```bash
+git clone https://github.com/programmersd21/shadlet
+cd shadlet
+uv venv --python 3.11
+uv pip install -e '.[dev]'
+cd packages/renderer && npm ci
+```
+
+checks:
+
+```bash
+ruff check .
+ruff format --check .
+mypy .
+pyright packages/python/shadlet
+pytest
+cd packages/renderer && npm run lint && npm run format:check && npm run typecheck && npm run test && npm run build
+python -m mkdocs build --strict
+```
+
+## compatibility
+
+- python 3.11 or newer
+- browsers: modern desktop browsers
+
+## community
+
+- [contributing](CONTRIBUTING.md)
+- [code of conduct](CODE_OF_CONDUCT.md)
+- [security](SECURITY.md)
+- [support](SUPPORT.md)
+- [discussions](https://github.com/programmersd21/shadlet/discussions)
+- [changelog](CHANGELOG.md)
+
+## ai assistance and transparency
+
+shadlet is developed by human maintainers with assistance from ai tooling.
+ai assistance is used for drafting, refactoring, documentation, and review support.
+all code is reviewed by maintainers and must pass the project's lint, type, test,
+and build checks before release. see [contributing](CONTRIBUTING.md) for the
+ai code policy.
+
+## license
+
+mit licensed. see [LICENSE](LICENSE) for full details.
+
+## status
+
+release ready (v0.1.1). see `docs/limitations.md` for the verified support matrix and capabilities.

shadlet-0.1.1/README.md

@@ -0,0 +1,223 @@
+<div align="center">
+
+![banner](https://raw.githubusercontent.com/programmersd21/shadlet/main/community/banner.png)
+
+[![ci](https://img.shields.io/github/actions/workflow/status/programmersd21/shadlet/ci.yml?branch=main&label=ci&style=flat-square)](https://github.com/programmersd21/shadlet/actions/workflows/ci.yml)
+[![docs](https://img.shields.io/github/actions/workflow/status/programmersd21/shadlet/docs.yml?branch=main&label=docs&style=flat-square)](https://github.com/programmersd21/shadlet/actions/workflows/docs.yml)
+[![python](https://img.shields.io/badge/python-3.11%2B-3776ab?style=flat-square&logo=python&logoColor=white)](https://www.python.org/)
+[![license](https://img.shields.io/github/license/programmersd21/shadlet?style=flat-square)](https://github.com/programmersd21/shadlet/blob/main/LICENSE)
+[![pypi](https://img.shields.io/pypi/v/shadlet?style=flat-square)](https://pypi.org/project/shadlet/)
+[![docs site](https://img.shields.io/badge/docs-online-5c4ee5?style=flat-square)](https://programmersd21.github.io/shadlet/)
+
+**python-first web applications with a genuine shadcn/ui renderer.**
+
+</div>
+
+shadlet is a framework that lets developers build modern web applications in python. react renders the interface with authentic shadcn/ui components. python manages application state, events, routing and server-side logic. end users run applications with python only; node.js is only needed to build the renderer.
+
+## showcase
+
+![demo1](https://raw.githubusercontent.com/programmersd21/shadlet/main/community/demo1.png)
+
+## why shadlet
+
+- python developers can build web applications using pure python.
+- the frontend is genuine shadcn/ui (tailwind + base-ui), not an imitation.
+- components are strictly typed and validated across the protocol.
+- reactive session state, async event handlers, and incremental patches.
+
+## comparison
+
+| feature | shadlet | typical python web ui |
+|---|---|---|
+| rendering | react + authentic shadcn/ui | server-rendered templates |
+| state | reactive session state | request/response state |
+| components | 56 built-in shadcn/ui components | custom widget sets |
+| packaging | python wheel with bundled renderer | manual frontend build |
+
+## features
+
+- typed python component api with enums and validation
+- 56 built-in components from shadcn/ui base-vega
+- official bundled geist variable & geist mono typography
+- smooth animations, backdrop blur, and spring physics
+- automatic port switching when default port is occupied
+- hot reload with diff-based patches
+- session-scoped reactive state
+- async event handlers with cancellation
+- versioned json protocol with incremental patches
+- typer and rich cli
+- github project templates
+- mkdocs documentation website
+
+## installation
+
+requirements:
+
+- python 3.11 or newer
+
+node.js is only required for maintainers building the renderer from source.
+
+```bash
+uv pip install -e '.[dev]'
+```
+
+verify:
+
+```bash
+shadlet doctor
+shadlet info
+```
+
+## quick start
+
+create a project:
+
+```bash
+shadlet create my-app
+cd my-app
+shadlet dev
+```
+
+or write `main.py` directly:
+
+```python
+import shadlet as ui
+
+app = ui.App("counter")
+
+
+@app.page("/")
+def home(ctx: ui.Context):
+    count = ctx.state(0, key="count")
+
+    def increment(event: ui.ClickEvent):
+        count.value += 1
+
+    return ui.Center(
+        ui.Column(
+            ui.Heading("counter"),
+            ui.Text(count),
+            ui.Button("increment", on_click=increment),
+            gap=16,
+        ),
+        min_height="100vh",
+    )
+
+
+if __name__ == "__main__":
+    app.run()
+```
+
+run:
+
+```bash
+python main.py
+```
+
+open `http://127.0.0.1:8000`.
+
+![demo2](https://raw.githubusercontent.com/programmersd21/shadlet/main/community/demo2.png)
+
+## architecture
+
+```mermaid
+flowchart LR
+  A[python application] --> B[component api]
+  B --> C[validation and normalisation]
+  C --> D[versioned json protocol]
+  D --> E[react renderer]
+  E --> F[browser]
+```
+
+- python handles application logic.
+- react handles rendering.
+- communication uses a versioned json protocol over websocket.
+
+## project structure
+
+```text
+shadlet/
+  packages/python/shadlet   python runtime
+  packages/renderer         react renderer
+  templates                 project templates
+  examples                  example applications
+  tests                     python tests
+  docs                      documentation
+```
+
+## examples
+
+- `examples/counter` minimal counter
+- `examples/todo` todo list with forms
+- `examples/dashboard` dashboard with charts and tables
+
+run any example:
+
+```bash
+cd examples/counter
+PYTHONPATH=../../packages/python python main.py
+```
+
+## documentation
+
+full documentation is in `docs/` and built with mkdocs.
+
+```bash
+python -m mkdocs serve
+python -m mkdocs build --strict
+```
+
+## development
+
+clone and set up:
+
+```bash
+git clone https://github.com/programmersd21/shadlet
+cd shadlet
+uv venv --python 3.11
+uv pip install -e '.[dev]'
+cd packages/renderer && npm ci
+```
+
+checks:
+
+```bash
+ruff check .
+ruff format --check .
+mypy .
+pyright packages/python/shadlet
+pytest
+cd packages/renderer && npm run lint && npm run format:check && npm run typecheck && npm run test && npm run build
+python -m mkdocs build --strict
+```
+
+## compatibility
+
+- python 3.11 or newer
+- browsers: modern desktop browsers
+
+## community
+
+- [contributing](CONTRIBUTING.md)
+- [code of conduct](CODE_OF_CONDUCT.md)
+- [security](SECURITY.md)
+- [support](SUPPORT.md)
+- [discussions](https://github.com/programmersd21/shadlet/discussions)
+- [changelog](CHANGELOG.md)
+
+## ai assistance and transparency
+
+shadlet is developed by human maintainers with assistance from ai tooling.
+ai assistance is used for drafting, refactoring, documentation, and review support.
+all code is reviewed by maintainers and must pass the project's lint, type, test,
+and build checks before release. see [contributing](CONTRIBUTING.md) for the
+ai code policy.
+
+## license
+
+mit licensed. see [LICENSE](LICENSE) for full details.
+
+## status
+
+release ready (v0.1.1). see `docs/limitations.md` for the verified support matrix and capabilities.