lightapi 0.1.4__tar.gz → 0.1.5__tar.gz

{lightapi-0.1.4 → lightapi-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lightapi
-Version: 0.1.4
+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
@@ -145,12 +145,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 = LightApi.from_config('config.yaml')
+api.run(host="0.0.0.0", port=8081)
 ```
 
 #### 4. Use the API (with curl)

{lightapi-0.1.4 → lightapi-0.1.5}/README.md

@@ -93,12 +93,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 = LightApi.from_config('config.yaml')
+api.run(host="0.0.0.0", port=8081)
 ```
 
 #### 4. Use the API (with curl)

{lightapi-0.1.4 → lightapi-0.1.5}/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.5}/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.5}/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.5}/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.5}/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.5}/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.5}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "lightapi"
-version = "0.1.4"
+version = "0.1.5"
 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.5}/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)