sqlite-webpanel 0.1.0__tar.gz

sqlite_webpanel-0.1.0/LICENSE

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

sqlite_webpanel-0.1.0/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: sqlite_webpanel
+Version: 0.1.0
+Summary: A plug-and-play SQLite admin panel for FastAPI — beautiful, fast, and intelligent by default.
+Author: Purva Sanjay Patel
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/purvaspatel
+Project-URL: Documentation, https://github.com/purvaspatel/sqlite-webpanel#readme
+Project-URL: Repository, https://github.com/purvaspatel/sqlit_webpanel
+Keywords: sqlite,fastapi,admin,panel,database
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: python-multipart>=0.0.6
+Requires-Dist: uvicorn>=0.22.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
+Requires-Dist: httpx>=0.24; extra == "dev"
+Requires-Dist: uvicorn>=0.22; extra == "dev"
+Dynamic: license-file
+
+# sqlite-panel
+
+> A plug-and-play SQLite admin panel for FastAPI — beautiful, fast, and intelligent by default.
+
+![Python](https://img.shields.io/badge/python-3.9+-blue)
+![FastAPI](https://img.shields.io/badge/FastAPI-0.100+-green)
+![License](https://img.shields.io/badge/license-MIT-lightgrey)
+
+---
+
+## Features
+
+- **One-line mount** — works with any FastAPI app
+- **Auto-discovery** — detects all tables and columns automatically
+- **Smart cell rendering** — JSON formatting, inline image previews, boolean badges, long text expand/collapse, file & URL links
+- **Pagination, sorting, filtering, search** — all built-in
+- **Inline editing** — double-click any cell to edit in place
+- **Real-time change detection** — toast notifications + auto-refresh when the DB changes
+- **Read-only mode** — disable all writes with a single flag
+- **Light & dark mode** — with smooth toggle and `localStorage` persistence
+- **Keyboard shortcuts** — `/` to search, `n` for new row, `Esc` to close modals
+- **SQL injection safe** — all user input is parameterised or strictly validated
+- **Zero heavy dependencies** — HTMX for partial refreshes, vanilla JS, Geist font via Google Fonts
+
+---
+
+## Installation
+
+```bash
+pip install sqlite_webpanel
+```
+
+## Quick start
+
+```python
+
+from sqlite_webpanel import run_panel
+run_panel(app, db_path="app.db")
+# → Visit http://localhost:8888/admin
+```
+
+---
+
+## Usage example
+
+```python
+# dbview.py
+from sqlite_webpanel import run_panel
+import sqlite3
+
+app = FastAPI()
+
+# Create some demo data
+conn = sqlite3.connect("demo.db")
+conn.execute("CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT, email TEXT)")
+conn.execute("INSERT OR IGNORE INTO users VALUES (1,'Alice','alice@example.com')")
+conn.commit()
+conn.close()
+
+run_panel(db_path="demo.db", title="Demo DB")
+
+# uvicorn main:app --reload
+```
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/yourname/sqlite_webpanel
+cd sqlite_webpanel
+pip install -e ".[dev]"
+pytest
+```
+
+---
+
+## Architecture
+
+```
+sqlite_panel/
+├── __init__.py        # Public API: mount_sqlite_panel
+├── mount.py           # FastAPI mounting + static files
+├── router.py          # All HTTP endpoints (web layer)
+├── db.py              # Core DB logic (pure Python, no web deps)
+├── renderers.py       # Smart cell → HTML conversion
+├── static/
+│   ├── panel.css      # All styles (CSS variables, light/dark)
+│   └── panel.js       # Interactivity (vanilla JS)
+└── templates/
+    ├── base.html      # Layout with sidebar
+    ├── table.html     # Table view with toolbar
+    ├── row_detail.html
+    ├── empty.html
+    ├── redirect.html
+    └── partials/
+        └── rows.html  # HTMX partial for table body
+```
+
+**Key design decisions:**
+
+- `db.py` has zero FastAPI/web imports — testable in isolation
+- `renderers.py` has zero DB imports — pure value → HTML transformation
+- All SQL uses parameterised queries or `_safe_identifier()` validation
+- HTMX partial endpoints allow row refresh without full page reload
+- Change detection via polling `/api/fingerprint` (row count hash)
+
+---
+
+## Keyboard shortcuts
+
+| Key | Action |
+|-----|--------|
+| `/` | Focus search |
+| `n` | Open "New Row" modal |
+| `Esc` | Close modal / cancel edit |
+| Double-click cell | Inline edit |
+
+---
+
+## License
+
+MIT

sqlite_webpanel-0.1.0/README.md

@@ -0,0 +1,123 @@
+# sqlite-panel
+
+> A plug-and-play SQLite admin panel for FastAPI — beautiful, fast, and intelligent by default.
+
+![Python](https://img.shields.io/badge/python-3.9+-blue)
+![FastAPI](https://img.shields.io/badge/FastAPI-0.100+-green)
+![License](https://img.shields.io/badge/license-MIT-lightgrey)
+
+---
+
+## Features
+
+- **One-line mount** — works with any FastAPI app
+- **Auto-discovery** — detects all tables and columns automatically
+- **Smart cell rendering** — JSON formatting, inline image previews, boolean badges, long text expand/collapse, file & URL links
+- **Pagination, sorting, filtering, search** — all built-in
+- **Inline editing** — double-click any cell to edit in place
+- **Real-time change detection** — toast notifications + auto-refresh when the DB changes
+- **Read-only mode** — disable all writes with a single flag
+- **Light & dark mode** — with smooth toggle and `localStorage` persistence
+- **Keyboard shortcuts** — `/` to search, `n` for new row, `Esc` to close modals
+- **SQL injection safe** — all user input is parameterised or strictly validated
+- **Zero heavy dependencies** — HTMX for partial refreshes, vanilla JS, Geist font via Google Fonts
+
+---
+
+## Installation
+
+```bash
+pip install sqlite_webpanel
+```
+
+## Quick start
+
+```python
+
+from sqlite_webpanel import run_panel
+run_panel(app, db_path="app.db")
+# → Visit http://localhost:8888/admin
+```
+
+---
+
+## Usage example
+
+```python
+# dbview.py
+from sqlite_webpanel import run_panel
+import sqlite3
+
+app = FastAPI()
+
+# Create some demo data
+conn = sqlite3.connect("demo.db")
+conn.execute("CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT, email TEXT)")
+conn.execute("INSERT OR IGNORE INTO users VALUES (1,'Alice','alice@example.com')")
+conn.commit()
+conn.close()
+
+run_panel(db_path="demo.db", title="Demo DB")
+
+# uvicorn main:app --reload
+```
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/yourname/sqlite_webpanel
+cd sqlite_webpanel
+pip install -e ".[dev]"
+pytest
+```
+
+---
+
+## Architecture
+
+```
+sqlite_panel/
+├── __init__.py        # Public API: mount_sqlite_panel
+├── mount.py           # FastAPI mounting + static files
+├── router.py          # All HTTP endpoints (web layer)
+├── db.py              # Core DB logic (pure Python, no web deps)
+├── renderers.py       # Smart cell → HTML conversion
+├── static/
+│   ├── panel.css      # All styles (CSS variables, light/dark)
+│   └── panel.js       # Interactivity (vanilla JS)
+└── templates/
+    ├── base.html      # Layout with sidebar
+    ├── table.html     # Table view with toolbar
+    ├── row_detail.html
+    ├── empty.html
+    ├── redirect.html
+    └── partials/
+        └── rows.html  # HTMX partial for table body
+```
+
+**Key design decisions:**
+
+- `db.py` has zero FastAPI/web imports — testable in isolation
+- `renderers.py` has zero DB imports — pure value → HTML transformation
+- All SQL uses parameterised queries or `_safe_identifier()` validation
+- HTMX partial endpoints allow row refresh without full page reload
+- Change detection via polling `/api/fingerprint` (row count hash)
+
+---
+
+## Keyboard shortcuts
+
+| Key | Action |
+|-----|--------|
+| `/` | Focus search |
+| `n` | Open "New Row" modal |
+| `Esc` | Close modal / cancel edit |
+| Double-click cell | Inline edit |
+
+---
+
+## License
+
+MIT

sqlite_webpanel-0.1.0/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.package-data]
+sqlite_webpanel = [
+    "static/*",
+    "templates/*",
+    "templates/partials/*",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["sqlite_webpanel*"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[project]
+name = "sqlite_webpanel"
+version = "0.1.0"
+description = "A plug-and-play SQLite admin panel for FastAPI — beautiful, fast, and intelligent by default."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Purva Sanjay Patel" }]
+keywords = ["sqlite", "fastapi", "admin", "panel", "database"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: FastAPI",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Database",
+    "Topic :: Internet :: WWW/HTTP",
+]
+requires-python = ">=3.9"
+dependencies = [
+    "fastapi>=0.100.0",
+    "jinja2>=3.1.0",
+    "python-multipart>=0.0.6",
+    "uvicorn>=0.22.0",
+]
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-asyncio>=0.21",
+    "httpx>=0.24",
+    "uvicorn>=0.22",
+]
+
+[project.urls]
+Homepage = "https://github.com/purvaspatel"
+Documentation = "https://github.com/purvaspatel/sqlite-webpanel#readme"
+Repository = "https://github.com/purvaspatel/sqlit_webpanel"
+

sqlite_webpanel-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sqlite_webpanel-0.1.0/src/sqlite_webpanel/__init__.py

@@ -0,0 +1,23 @@
+"""
+sqlite_webpanel: A plug-and-play SQLite admin panel for FastAPI.
+
+Usage:
+    from sqlite_webpanel import mount_sqlite_panel, Database, _safe_identifier
+
+    mount_sqlite_panel(app, db_path="app.db")
+"""
+
+from .mount import mount_sqlite_panel, run_panel
+from .db import Database, _safe_identifier
+from .renderers import render_cell
+
+__all__ = [
+    "mount_sqlite_panel",
+    "Database",
+    "_safe_identifier",
+    "render_cell",
+    "run_panel"
+    # add other things you want exposed
+]
+
+__version__ = "0.1.0"