lightapi 0.1.4__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.4 → lightapi-0.1.6}/docs/api-reference/core.md

@@ -83,24 +83,14 @@ app.add_middleware([
 **Parameters:**
 - `middleware_classes` (List[Type[Middleware]]): List of middleware classes to add
 
-#### run()
+#### run(host: str = "0.0.0.0", port: int = 8000, debug: bool = False) -> None
 
-Starts the development server.
-
-```python
-app.run(
-    host="0.0.0.0",
-    port=8000,
-    debug=True,
-    reload=True
-)
-```
+Starts the server. This is the only supported way to start the application. Do not use external libraries to start the server directly.
 
 **Parameters:**
 - `host` (str): Server host address
 - `port` (int): Server port number
 - `debug` (bool): Enable debug mode
-- `reload` (bool): Enable auto-reload on code changes
 
 ### Advanced Configuration
 

{lightapi-0.1.4 → lightapi-0.1.6}/docs/api-reference/rest.md

@@ -747,8 +747,10 @@ class User(RestEndpoint):
 - [Core API](core.md) - Core framework functionality
 - [Models](models.md) - Data models and schemas
 - [Filtering](filters.md) - Advanced filtering options
-- [Pagination](pagination.md) - Pagination configuration
+- [Pagination](pagination.md) - Pagination configuration 
 
 - Only GET, POST, PUT, PATCH, DELETE HTTP verbs are supported. OPTIONS and HEAD are not available.
 - 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. 
+- 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. 
+
+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-0.1.4 → lightapi-0.1.6}/docs/getting-started/quickstart.md

@@ -70,10 +70,8 @@ sqlite3 mydata.db "CREATE TABLE users (id INTEGER PRIMARY KEY AUTOINCREMENT, nam
 **3. Start the API:**
 ```python
 from lightapi import LightApi
-import aiohttp.web
 api = LightApi.from_config('my_api_config.yaml')
-app = api.app
-aiohttp.web.run_app(app, port=8080)
+api.run(host="0.0.0.0", port=8080)
 ```
 
 **4. Use the API (with curl):**

{lightapi-0.1.4 → lightapi-0.1.6}/docs/index.md

@@ -158,3 +158,5 @@ LightAPI is released under the [MIT License](https://github.com/henriqueblobato/
 
 > **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.
 
+> 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-0.1.4 → lightapi-0.1.6}/docs/technical-reference/core-api.md

@@ -50,7 +50,7 @@ Adds application-wide middleware.
 
 #### run(host: str = "0.0.0.0", port: int = 8000, debug: bool = False) -> None
 
-Starts the ASGI server using Uvicorn.
+Starts the server. This is the only supported way to start the application. Do not use external libraries to start the server directly.
 
 - **Parameters:**
   - `host`: Host address to bind (default: `"0.0.0.0"`).

{lightapi-0.1.4 → lightapi-0.1.6}/lightapi/lightapi.py

@@ -119,6 +119,7 @@ class LightApi:
             port (int): The port number on which the server will listen. Defaults to 8000.
         """
         self.app.add_routes(self.routes)
+        # Only use this method to start the server
         web.run_app(self.app, host=host, port=port)
 
     @classmethod

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

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "lightapi"
-version = "0.1.4"
+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.4 → lightapi-0.1.6}/run_server.py

@@ -1,8 +1,6 @@
 from lightapi import LightApi
-import aiohttp.web
 
 api = LightApi.from_config('test_server.yaml')
-app = api.app
 
 if __name__ == "__main__":
-    aiohttp.web.run_app(app, port=8081) 
+    api.run(host="0.0.0.0", port=8081)