d

README.md

@@ -1,156 +1,8 @@
-# SQLite Server on HF Spaces
-
-A persistent SQLite database server running on Hugging Face Spaces with FastAPI wrapper.
-
-## Features
-
-✅ **Persistent Storage** - Data stored in `/data/sqlite.db` (survives restarts)
-✅ **REST API** - Full SQLite CRUD operations via HTTP
-✅ **Dual Services** - SQLite server (port 8000) + FastAPI wrapper (port 7860)
-✅ **Schema Management** - Query schema and list tables
-✅ **HF Spaces Ready** - Docker setup for Hugging Face deployment
-
-## Architecture
-
-```
-┌─────────────────────────────────────────────┐
-│         HF Spaces Container                 │
-├─────────────────────────────────────────────┤
-│  Port 7860 (exposed)                        │
-│  ├── FastAPI Wrapper (app.py)               │
-│  │   └── Proxies to SQLite Server           │
-│  │                                          │
-│  Port 8000 (internal)                       │
-│  └── SQLite Server (sqlite_server.py)       │
-│      └── /data/sqlite.db (persistent)       │
-└─────────────────────────────────────────────┘
-```
-
-## API Endpoints
-
-### Health Check
-```bash
-GET /health
-GET /api/v1/heartbeat
-```
-
-### Query Data (SELECT)
-```bash
-POST /api/v1/query
-Content-Type: application/json
-
-{
-  "sql": "SELECT * FROM users"
-}
-```
-
-### Execute (INSERT/UPDATE/DELETE)
-```bash
-POST /api/v1/execute
-Content-Type: application/json
-
-{
-  "sql": "INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com')"
-}
-```
-
-### Schema & Tables
-```bash
-GET /api/v1/tables
-GET /api/v1/schema
-```
-
-## Deployment to HF Spaces
-
-1. **Create a new Space:**
-   - Go to https://huggingface.co/new-space
-   - Select "Docker" as SDK
-   - Upload/push this repo
-
-2. **Files needed:**
-   - `Dockerfile` - Container setup
-   - `start.sh` - Startup script
-   - `app.py` - FastAPI wrapper
-   - `sqlite_server.py` - SQLite API server
-   - `requirements.txt` - Python dependencies
-
-3. **Persistent Storage:**
-   - HF Spaces automatically mounts `/data` as persistent volume
-   - SQLite database is stored at `/data/sqlite.db`
-   - Data persists across Space restarts
-
-## Local Testing
-
-```bash
-# Install dependencies
-npm install
-pip install -r requirements.txt
-
-# Start the servers
-source venv/bin/activate
-python3 sqlite_server.py &  # Port 8000
-python3 app.py &             # Port 7860
-
-# Run tests
-npm run test
-```
-
-## File Structure
-
-```
-.
-├── app.py                 # FastAPI wrapper (port 7860)
-├── sqlite_server.py       # SQLite API server (port 8000)
-├── start.sh              # Startup script
-├── Dockerfile            # Container configuration
-├── requirements.txt      # Python dependencies
-├── package.json         # Node.js test config
-├── test.js              # Test suite
-└── README.md            # This file
-```
-
-## Example Usage
-
-### Create a table
-```bash
-curl -X POST https://your-space.hf.space/api/v1/execute \
-  -H "Content-Type: application/json" \
-  -d '{
-    "sql": "CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, email TEXT)"
-  }'
-```
-
-### Insert data
-```bash
-curl -X POST https://your-space.hf.space/api/v1/execute \
-  -H "Content-Type: application/json" \
-  -d '{
-    "sql": "INSERT INTO users (name, email) VALUES ('"'"'Alice'"'"', '"'"'alice@example.com'"'"')"
-  }'
-```
-
-### Query data
-```bash
-curl -X POST https://your-space.hf.space/api/v1/query \
-  -H "Content-Type: application/json" \
-  -d '{"sql": "SELECT * FROM users"}'
-```
-
-## Troubleshooting
-
-**Health check fails:**
-- Ensure SQLite server started before FastAPI wrapper
-- Check `start.sh` sleep duration (currently 2 seconds)
-
-**Port conflicts:**
-- SQLite server: port 8000 (internal)
-- FastAPI wrapper: port 7860 (exposed on HF Spaces)
-
-**Data not persisting:**
-- Verify `/data` directory exists
-- Check HF Spaces has persistent storage enabled
-- Database file should be at `/data/sqlite.db`
-
-## Credits
-
-Pattern based on ChromaDB HF Spaces deployment.
+---
+title: SqlLIte
+emoji: 🦀
+colorFrom: gray
+colorTo: green
+sdk: docker
+pinned: false
+---