lightapi 0.1.5__tar.gz → 0.1.6__tar.gz

lightapi-0.1.6/PKG-INFO

@@ -0,0 +1,214 @@
+Metadata-Version: 2.4
+Name: lightapi
+Version: 0.1.6
+Summary: A lightweight framework for building API endpoints using Python's native libraries.
+Project-URL: Repository, https://github.com/henriqueblobato/LightApi
+Project-URL: Issues, https://github.com/henriqueblobato/LightApi/issues
+Project-URL: Homepage, https://github.com/henriqueblobato/LightApi
+Author-email: iklobato <iklobato1@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: api,endpoint,framework,lightweight,rest,restful
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.8.1
+Requires-Dist: aiohttp<4.0.0,>=3.9.5
+Requires-Dist: pyjwt<3.0.0,>=2.8.0
+Requires-Dist: pyyaml>=5.1
+Requires-Dist: redis<6.0.0,>=5.0.0
+Requires-Dist: sqlalchemy<3.0.0,>=2.0.30
+Requires-Dist: starlette<1.0.0,>=0.37.0
+Requires-Dist: uvicorn<1.0.0,>=0.30.0
+Provides-Extra: dev
+Requires-Dist: black<24.0.0,>=23.3.0; extra == 'dev'
+Requires-Dist: flake8<7.0.0,>=6.0.0; extra == 'dev'
+Requires-Dist: isort<6.0.0,>=5.12.0; extra == 'dev'
+Requires-Dist: mypy<2.0.0,>=1.3.0; extra == 'dev'
+Requires-Dist: pytest<8.0.0,>=7.3.1; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-awesome-pages-plugin; extra == 'docs'
+Requires-Dist: mkdocs-git-authors-plugin; extra == 'docs'
+Requires-Dist: mkdocs-git-committers-plugin-2; extra == 'docs'
+Requires-Dist: mkdocs-git-revision-date-localized-plugin; extra == 'docs'
+Requires-Dist: mkdocs-glightbox; extra == 'docs'
+Requires-Dist: mkdocs-material; extra == 'docs'
+Requires-Dist: mkdocstrings[python]; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: httpx<1.0.0,>=0.27.0; extra == 'test'
+Requires-Dist: pyjwt<3.0.0,>=2.8.0; extra == 'test'
+Requires-Dist: pytest<8.0.0,>=7.3.1; extra == 'test'
+Requires-Dist: redis<6.0.0,>=5.0.0; extra == 'test'
+Requires-Dist: starlette<1.0.0,>=0.37.0; extra == 'test'
+Requires-Dist: uvicorn<1.0.0,>=0.30.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# LightAPI: Instant Python REST APIs from SQL Databases
+
+[![PyPI version](https://badge.fury.io/py/lightapi.svg)](https://pypi.org/project/lightapi/)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**LightAPI** is a modern Python framework for building high-performance REST APIs directly from your SQL database—no boilerplate, no manual endpoint wiring. Instantly expose CRUD endpoints from SQLAlchemy models or a YAML config, with full support for authentication, caching, validation, filtering, and OpenAPI documentation.
+
+---
+
+## Why use LightAPI?
+
+- **Zero-boilerplate Python REST API**: Instantly generate CRUD endpoints from your database schema.
+- **YAML-driven API generator**: Reflect your database and expose only the tables and operations you want.
+- **Async and Fast**: Built on aiohttp for high concurrency and low latency.
+- **Production-ready**: JWT authentication, Redis caching, request validation, and robust error handling.
+- **Automatic OpenAPI docs**: Swagger UI and OpenAPI JSON out of the box.
+- **Flexible**: Use with SQLite, PostgreSQL, MySQL, or any SQLAlchemy-supported database.
+- **Modern Python**: Type hints, async/await, and best practices throughout.
+
+---
+
+## Who is this for?
+
+- **Backend developers** who want to ship APIs fast, with minimal code.
+- **Data engineers** needing to expose existing databases as RESTful services.
+- **Prototypers** and **startups** who want to iterate quickly and scale later.
+- **Anyone** who wants a clean, maintainable, and extensible Python API stack.
+
+---
+
+## Features
+
+- 🚀 **Automatic CRUD endpoints** from SQLAlchemy models or YAML config
+- 🔄 **Database reflection**: Expose existing tables instantly
+- 🔐 **JWT authentication** with CORS support
+- ⚡ **Async performance** (aiohttp)
+- 💾 **Redis caching** with auto-invalidation
+- 🧪 **Request validation** and error handling
+- 🔍 **Filtering, pagination, and sorting**
+- 📖 **OpenAPI/Swagger documentation** auto-generated
+- 🔧 **Custom middleware** support
+- 🗄️ **Works with SQLite, PostgreSQL, MySQL, and more**
+- 📝 **Environment-based configuration**
+
+---
+
+## Quick Start
+
+### 1. Install LightAPI
+
+```bash
+pip install lightapi
+```
+
+### 2. Define your model (SQLAlchemy)
+
+```python
+from lightapi import LightApi
+from lightapi.database import Base
+from sqlalchemy import Column, Integer, String
+
+class User(Base):
+    __tablename__ = "users"
+    id = Column(Integer, primary_key=True)
+    name = Column(String(50))
+    email = Column(String(100))
+
+app = LightApi()
+app.register(User)
+
+if __name__ == "__main__":
+    app.run()
+```
+
+### 3. Or use YAML for instant API from your database
+
+```yaml
+# config.yaml
+database_url: sqlite:///mydata.db
+tables:
+  - name: users
+    crud: [get, post, put, patch, delete]
+  - name: orders
+    crud: [get, post]
+```
+
+```python
+from lightapi import LightApi
+api = LightApi.from_config('config.yaml')
+api.run(host="0.0.0.0", port=8081)
+```
+
+---
+
+## Example Endpoints (from YAML above)
+
+- `GET    /users/`         - List users
+- `POST   /users/`         - Create user
+- `GET    /users/{id}`     - Get user by ID
+- `PUT    /users/{id}`     - Replace user
+- `PATCH  /users/{id}`     - Update user
+- `DELETE /users/{id}`     - Delete user
+- `GET    /orders/`        - List orders
+- `POST   /orders/`        - Create order
+- `GET    /orders/{id}`    - Get order by ID
+
+---
+
+## Documentation
+
+- [Full Documentation](https://iklobato.github.io/lightapi/)
+- [Getting Started](https://iklobato.github.io/lightapi/getting-started/installation/)
+- [API Reference](https://iklobato.github.io/lightapi/api-reference/core/)
+- [Examples](https://iklobato.github.io/lightapi/examples/basic-rest/)
+
+---
+
+## FAQ
+
+**Q: Can I use LightAPI with my existing database?**  
+A: Yes! Use the YAML config to reflect your schema and instantly expose REST endpoints.
+
+**Q: What databases are supported?**  
+A: Any database supported by SQLAlchemy (PostgreSQL, MySQL, SQLite, etc.).
+
+**Q: How do I secure my API?**  
+A: Enable JWT authentication and CORS with a single line.
+
+**Q: Can I customize endpoints or add business logic?**  
+A: Yes, you can extend or override any handler, add middleware, and use validators.
+
+**Q: Is this production-ready?**  
+A: Yes. LightAPI is designed for both rapid prototyping and production deployment.
+
+---
+
+## Comparison
+
+| Feature                | LightAPI | FastAPI | Flask | Django REST |
+|------------------------|----------|--------|-------|-------------|
+| Zero-boilerplate CRUD  | ✅       | ❌     | ❌    | ❌          |
+| YAML-driven API        | ✅       | ❌     | ❌    | ❌          |
+| Async support          | ✅       | ✅     | ❌    | ❌          |
+| OpenAPI docs           | ✅       | ✅     | ❌    | ✅          |
+| Built-in Auth/Caching  | ✅       | ❌     | ❌    | ✅          |
+| DB Reflection          | ✅       | ❌     | ❌    | ❌          |
+
+---
+
+## License
+
+MIT License. See [LICENSE](LICENSE).
+
+---
+
+> **Note:** Only GET, POST, PUT, PATCH, DELETE HTTP verbs are supported. Required fields must be NOT NULL in the schema. Constraint violations (NOT NULL, UNIQUE, FK) return 409.  
+> To start your API, always use `api.run(host, port)`. Do not use external libraries or `app = api.app` to start the server directly.
+
+---
+
+**LightAPI** - *The fastest way to build Python REST APIs from your database.*

lightapi-0.1.6/README.md

@@ -0,0 +1,162 @@
+# LightAPI: Instant Python REST APIs from SQL Databases
+
+[![PyPI version](https://badge.fury.io/py/lightapi.svg)](https://pypi.org/project/lightapi/)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**LightAPI** is a modern Python framework for building high-performance REST APIs directly from your SQL database—no boilerplate, no manual endpoint wiring. Instantly expose CRUD endpoints from SQLAlchemy models or a YAML config, with full support for authentication, caching, validation, filtering, and OpenAPI documentation.
+
+---
+
+## Why use LightAPI?
+
+- **Zero-boilerplate Python REST API**: Instantly generate CRUD endpoints from your database schema.
+- **YAML-driven API generator**: Reflect your database and expose only the tables and operations you want.
+- **Async and Fast**: Built on aiohttp for high concurrency and low latency.
+- **Production-ready**: JWT authentication, Redis caching, request validation, and robust error handling.
+- **Automatic OpenAPI docs**: Swagger UI and OpenAPI JSON out of the box.
+- **Flexible**: Use with SQLite, PostgreSQL, MySQL, or any SQLAlchemy-supported database.
+- **Modern Python**: Type hints, async/await, and best practices throughout.
+
+---
+
+## Who is this for?
+
+- **Backend developers** who want to ship APIs fast, with minimal code.
+- **Data engineers** needing to expose existing databases as RESTful services.
+- **Prototypers** and **startups** who want to iterate quickly and scale later.
+- **Anyone** who wants a clean, maintainable, and extensible Python API stack.
+
+---
+
+## Features
+
+- 🚀 **Automatic CRUD endpoints** from SQLAlchemy models or YAML config
+- 🔄 **Database reflection**: Expose existing tables instantly
+- 🔐 **JWT authentication** with CORS support
+- ⚡ **Async performance** (aiohttp)
+- 💾 **Redis caching** with auto-invalidation
+- 🧪 **Request validation** and error handling
+- 🔍 **Filtering, pagination, and sorting**
+- 📖 **OpenAPI/Swagger documentation** auto-generated
+- 🔧 **Custom middleware** support
+- 🗄️ **Works with SQLite, PostgreSQL, MySQL, and more**
+- 📝 **Environment-based configuration**
+
+---
+
+## Quick Start
+
+### 1. Install LightAPI
+
+```bash
+pip install lightapi
+```
+
+### 2. Define your model (SQLAlchemy)
+
+```python
+from lightapi import LightApi
+from lightapi.database import Base
+from sqlalchemy import Column, Integer, String
+
+class User(Base):
+    __tablename__ = "users"
+    id = Column(Integer, primary_key=True)
+    name = Column(String(50))
+    email = Column(String(100))
+
+app = LightApi()
+app.register(User)
+
+if __name__ == "__main__":
+    app.run()
+```
+
+### 3. Or use YAML for instant API from your database
+
+```yaml
+# config.yaml
+database_url: sqlite:///mydata.db
+tables:
+  - name: users
+    crud: [get, post, put, patch, delete]
+  - name: orders
+    crud: [get, post]
+```
+
+```python
+from lightapi import LightApi
+api = LightApi.from_config('config.yaml')
+api.run(host="0.0.0.0", port=8081)
+```
+
+---
+
+## Example Endpoints (from YAML above)
+
+- `GET    /users/`         - List users
+- `POST   /users/`         - Create user
+- `GET    /users/{id}`     - Get user by ID
+- `PUT    /users/{id}`     - Replace user
+- `PATCH  /users/{id}`     - Update user
+- `DELETE /users/{id}`     - Delete user
+- `GET    /orders/`        - List orders
+- `POST   /orders/`        - Create order
+- `GET    /orders/{id}`    - Get order by ID
+
+---
+
+## Documentation
+
+- [Full Documentation](https://iklobato.github.io/lightapi/)
+- [Getting Started](https://iklobato.github.io/lightapi/getting-started/installation/)
+- [API Reference](https://iklobato.github.io/lightapi/api-reference/core/)
+- [Examples](https://iklobato.github.io/lightapi/examples/basic-rest/)
+
+---
+
+## FAQ
+
+**Q: Can I use LightAPI with my existing database?**  
+A: Yes! Use the YAML config to reflect your schema and instantly expose REST endpoints.
+
+**Q: What databases are supported?**  
+A: Any database supported by SQLAlchemy (PostgreSQL, MySQL, SQLite, etc.).
+
+**Q: How do I secure my API?**  
+A: Enable JWT authentication and CORS with a single line.
+
+**Q: Can I customize endpoints or add business logic?**  
+A: Yes, you can extend or override any handler, add middleware, and use validators.
+
+**Q: Is this production-ready?**  
+A: Yes. LightAPI is designed for both rapid prototyping and production deployment.
+
+---
+
+## Comparison
+
+| Feature                | LightAPI | FastAPI | Flask | Django REST |
+|------------------------|----------|--------|-------|-------------|
+| Zero-boilerplate CRUD  | ✅       | ❌     | ❌    | ❌          |
+| YAML-driven API        | ✅       | ❌     | ❌    | ❌          |
+| Async support          | ✅       | ✅     | ❌    | ❌          |
+| OpenAPI docs           | ✅       | ✅     | ❌    | ✅          |
+| Built-in Auth/Caching  | ✅       | ❌     | ❌    | ✅          |
+| DB Reflection          | ✅       | ❌     | ❌    | ❌          |
+
+---
+
+## License
+
+MIT License. See [LICENSE](LICENSE).
+
+---
+
+> **Note:** Only GET, POST, PUT, PATCH, DELETE HTTP verbs are supported. Required fields must be NOT NULL in the schema. Constraint violations (NOT NULL, UNIQUE, FK) return 409.  
+> To start your API, always use `api.run(host, port)`. Do not use external libraries or `app = api.app` to start the server directly.
+
+---
+
+**LightAPI** - *The fastest way to build Python REST APIs from your database.*

{lightapi-0.1.5 → lightapi-0.1.6}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "lightapi"
-version = "0.1.5"
+version = "0.1.6"
 description = "A lightweight framework for building API endpoints using Python's native libraries."
 readme = "README.md"
 requires-python = ">=3.8.1"

lightapi-0.1.5/PKG-INFO

@@ -1,273 +0,0 @@
-Metadata-Version: 2.4
-Name: lightapi
-Version: 0.1.5
-Summary: A lightweight framework for building API endpoints using Python's native libraries.
-Project-URL: Repository, https://github.com/henriqueblobato/LightApi
-Project-URL: Issues, https://github.com/henriqueblobato/LightApi/issues
-Project-URL: Homepage, https://github.com/henriqueblobato/LightApi
-Author-email: iklobato <iklobato1@gmail.com>
-License: MIT
-License-File: LICENSE
-Keywords: api,endpoint,framework,lightweight,rest,restful
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Internet :: WWW/HTTP
-Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
-Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
-Requires-Python: >=3.8.1
-Requires-Dist: aiohttp<4.0.0,>=3.9.5
-Requires-Dist: pyjwt<3.0.0,>=2.8.0
-Requires-Dist: pyyaml>=5.1
-Requires-Dist: redis<6.0.0,>=5.0.0
-Requires-Dist: sqlalchemy<3.0.0,>=2.0.30
-Requires-Dist: starlette<1.0.0,>=0.37.0
-Requires-Dist: uvicorn<1.0.0,>=0.30.0
-Provides-Extra: dev
-Requires-Dist: black<24.0.0,>=23.3.0; extra == 'dev'
-Requires-Dist: flake8<7.0.0,>=6.0.0; extra == 'dev'
-Requires-Dist: isort<6.0.0,>=5.12.0; extra == 'dev'
-Requires-Dist: mypy<2.0.0,>=1.3.0; extra == 'dev'
-Requires-Dist: pytest<8.0.0,>=7.3.1; extra == 'dev'
-Provides-Extra: docs
-Requires-Dist: mkdocs-awesome-pages-plugin; extra == 'docs'
-Requires-Dist: mkdocs-git-authors-plugin; extra == 'docs'
-Requires-Dist: mkdocs-git-committers-plugin-2; extra == 'docs'
-Requires-Dist: mkdocs-git-revision-date-localized-plugin; extra == 'docs'
-Requires-Dist: mkdocs-glightbox; extra == 'docs'
-Requires-Dist: mkdocs-material; extra == 'docs'
-Requires-Dist: mkdocstrings[python]; extra == 'docs'
-Provides-Extra: test
-Requires-Dist: httpx<1.0.0,>=0.27.0; extra == 'test'
-Requires-Dist: pyjwt<3.0.0,>=2.8.0; extra == 'test'
-Requires-Dist: pytest<8.0.0,>=7.3.1; extra == 'test'
-Requires-Dist: redis<6.0.0,>=5.0.0; extra == 'test'
-Requires-Dist: starlette<1.0.0,>=0.37.0; extra == 'test'
-Requires-Dist: uvicorn<1.0.0,>=0.30.0; extra == 'test'
-Description-Content-Type: text/markdown
-
-# LightAPI
-
-[![PyPI version](https://badge.fury.io/py/lightapi.svg)](https://badge.fury.io/py/lightapi)
-[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-A lightweight, fast, and easy-to-use web API framework for Python with automatic REST endpoint generation, built-in authentication, caching, and more.
-
-## Features
-
-- 🚀 **Zero-boilerplate REST APIs** - Automatically generate CRUD operations from SQLAlchemy models
-- 🔐 **Built-in Authentication** - JWT authentication with automatic CORS handling
-- ⚡ **High Performance** - Built on Starlette for async support and speed
-- 💾 **Smart Caching** - Redis-based caching with automatic invalidation
-- 📊 **Request Validation** - Automatic request validation and error handling
-- 🔍 **Advanced Filtering** - Query filtering, pagination, and sorting out of the box
-- 📖 **Auto Documentation** - Automatic OpenAPI/Swagger documentation generation
-- 🔧 **Flexible Middleware** - Easy middleware system for custom logic
-- 🗄️ **Database Integration** - Seamless SQLAlchemy integration with automatic table creation
-- ⚙️ **Environment Configuration** - Easy configuration management
-
-## Quick Start
-
-### Installation
-
-```bash
-pip install lightapi
-```
-
-### Basic Usage
-
-```python
-from lightapi import LightApi
-from lightapi.database import Base
-from sqlalchemy import Column, Integer, String
-
-# Define your model
-class User(Base):
-    __tablename__ = "users"
-    
-    id = Column(Integer, primary_key=True)
-    name = Column(String(50))
-    email = Column(String(100))
-
-# Create API instance
-app = LightApi()
-
-# Register your model - automatically creates CRUD endpoints
-app.register(User)
-
-# Run the server
-if __name__ == "__main__":
-    app.run()
-```
-
-That's it! You now have a fully functional REST API with:
-- `GET /users` - List all users with filtering and pagination
-- `GET /users/{id}` - Get user by ID
-- `POST /users` - Create new user
-- `PUT /users/{id}` - Update user
-- `DELETE /users/{id}` - Delete user
-- `OPTIONS /users` - CORS preflight support
-
-## Dynamic API from YAML Config (SQLAlchemy Reflection)
-
-LightAPI can instantly generate a REST API from a YAML configuration file, reflecting your database schema at runtime using SQLAlchemy. This is ideal for exposing existing databases with zero model code.
-
-### How It Works
-- **Reflects** the schema of specified tables from your database (PostgreSQL, MySQL, SQLite, etc.)
-- **Dynamically generates** SQLAlchemy models and CRUD endpoints for each table
-- **Configurable**: You control which tables and which CRUD operations (GET, POST, PUT, PATCH, DELETE) are exposed
-- **Composite primary keys, unique constraints, foreign keys, BLOBs, JSON, and more** are supported
-- **Advanced edge cases** (triggers, generated columns, partial unique constraints, etc.) are handled
-
-### End-to-End Example
-
-#### 1. Create a YAML Config
-```yaml
-database_url: sqlite:///mydata.db
-
-tables:
-  - name: users
-    crud: [get, post, put, patch, delete]
-  - name: orders
-    crud: [get, post]
-```
-
-#### 2. Create Your Database (SQLite example)
-```bash
-sqlite3 mydata.db "CREATE TABLE users (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT NOT NULL, email TEXT NOT NULL UNIQUE); CREATE TABLE orders (id INTEGER PRIMARY KEY AUTOINCREMENT, user_id INTEGER NOT NULL, amount REAL NOT NULL, FOREIGN KEY(user_id) REFERENCES users(id));"
-```
-
-#### 3. Start the API
-```python
-from lightapi import LightApi
-api = LightApi.from_config('config.yaml')
-api.run(host="0.0.0.0", port=8081)
-```
-
-#### 4. Use the API (with curl)
-```bash
-# Create a user
-curl -X POST http://localhost:8080/users/ -H 'Content-Type: application/json' -d '{"name": "Alice", "email": "alice@example.com"}'
-
-# List users
-curl http://localhost:8080/users/
-
-# Create an order for Alice (id=1)
-curl -X POST http://localhost:8080/orders/ -H 'Content-Type: application/json' -d '{"user_id": 1, "amount": 42.5}'
-
-# List orders
-curl http://localhost:8080/orders/
-```
-
-### FAQ & Tips
-- **Server-side defaults**: Only `server_default` (e.g., `server_default=text('...')`) are available after reflection. Python-side defaults are not reflected.
-- **Composite PKs**: Supported transparently in routes and handlers.
-- **Error handling**: Unique, check, not null, and foreign key constraints are enforced. Violations return 409 Conflict with details.
-- **Partial CRUD**: You can expose only the operations you want per table.
-- **Supported DBs**: Any DB supported by SQLAlchemy reflection (PostgreSQL, MySQL, SQLite, etc.)
-
-See the [docs](./docs/getting-started/quickstart.md#dynamic-api-from-yaml-config-sqlalchemy-reflection) for more advanced examples and details.
-
-## Documentation
-
-Visit our comprehensive documentation at: https://iklobato.github.io/lightapi/
-
-- [Getting Started Guide](https://iklobato.github.io/lightapi/getting-started/installation/)
-- [API Reference](https://iklobato.github.io/lightapi/api-reference/core/)
-- [Examples](https://iklobato.github.io/lightapi/examples/basic-rest/)
-
-## Advanced Features
-
-### Authentication
-
-```python
-from lightapi.auth import JWTAuthentication
-
-# Add JWT authentication
-auth = JWTAuthentication(secret_key="your-secret-key")
-app.add_middleware(auth)
-
-# Protected endpoints automatically require valid JWT tokens
-```
-
-### Caching
-
-```python
-from lightapi.cache import RedisCache
-
-# Add Redis caching
-cache = RedisCache(host="localhost", port=6379)
-app.register(User, cache=cache, cache_ttl=300)  # 5 minutes TTL
-```
-
-### Validation
-
-```python
-from lightapi.rest import Validator
-
-class UserValidator(Validator):
-    def validate_post(self, data):
-        if not data.get("email"):
-            raise ValueError("Email is required")
-        return data
-
-app.register(User, validator=UserValidator())
-```
-
-- All required fields must be defined as NOT NULL in your database schema for correct enforcement.
-- The API will return 409 Conflict if you attempt to create or update a record missing a NOT NULL field, or violating a UNIQUE or FOREIGN KEY constraint.
-
-### Middleware
-
-```python
-from lightapi.core import Middleware
-
-class LoggingMiddleware(Middleware):
-    async def process(self, request, call_next):
-        print(f"Request: {request.method} {request.url}")
-        response = await call_next(request)
-        print(f"Response: {response.status_code}")
-        return response
-
-app.add_middleware(LoggingMiddleware())
-```
-
-## Why LightAPI?
-
-- **Rapid Development**: Get REST APIs running in minutes, not hours
-- **Production Ready**: Built-in security, caching, and error handling
-- **Flexible**: Customize every aspect while keeping defaults simple
-- **Modern**: Async support, type hints, and contemporary Python practices
-- **Well Documented**: Comprehensive docs with real-world examples
-
-## Examples
-
-Check out the [examples directory](./examples/) for complete applications:
-
-- [Basic REST API](./examples/basic_rest_api.py) - Simple CRUD operations
-- [Authentication](./examples/auth_example.py) - JWT authentication
-- [Caching](./examples/caching_example.py) - Redis caching implementation
-- [Validation](./examples/validation_example.py) - Request validation
-- [Middleware](./examples/middleware_example.py) - Custom middleware
-- [Filtering & Pagination](./examples/filtering_pagination_example.py) - Advanced queries
-
-## Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request.
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
----
-
-**LightAPI** - *Making web APIs light and fast* ⚡
-
-<!-- Testing development pipeline -->
-
-> **Note:** Only GET, POST, PUT, PATCH, DELETE HTTP verbs are supported. OPTIONS and HEAD are not available. Required fields must be NOT NULL in the schema. Constraint violations (NOT NULL, UNIQUE, FK) return 409.