Merge pull request #89 from eadwinCode/package_dependency_fix

ellar package dependency refactor

Author: eadwinCode

README.md

@@ -85,7 +85,7 @@ ellar create-module car
 ## **Add Schema**
 In `car/schema.py`, lets add some serializer for car input and output data
 ```python
-from ellar.core.serializer import Serializer
+from ellar.common import Serializer
 
 class CarSerializer(Serializer):
     name: str
@@ -155,9 +155,8 @@ In `car/controllers.py`, lets create `CarController`
 
 ```python
 import typing as t
-from ellar.common import Controller, delete, get, put, post
-from ellar.core import ControllerBase
-from ellar.core.exceptions import NotFound
+from ellar.common import Controller, delete, get, put, post, ControllerBase
+from ellar.common.exceptions import NotFound
 from .schemas import CarSerializer, RetrieveCarSerializer
 from .services import CarDummyDB
 
@@ -225,8 +224,8 @@ class CarModule(ModuleBase):
 ## **Registering Module**
 Ellar is not aware of `CarModule` yet, so we need to add it to the `modules` list of `ApplicationModule` at the `carsite/root_module.py`.
 ```python
-from ellar.common import Module, exception_handler
-from ellar.core import IHostContext, ModuleBase, JSONResponse, Response
+from ellar.common import Module, exception_handler, JSONResponse, Response, IHostContext
+from ellar.core import ModuleBase
 
 from ellar.samples.modules import HomeModule
 from .apps.car.module import CarModule

docs/basics/execution-context.md

@@ -15,9 +15,7 @@ For example, the `catch()` method of an **exception handlers** is called with an
 ```python
 # project_name/apps/custom_exceptions.py
 import typing as t
-from ellar.core.exceptions import IExceptionHandler
-from ellar.core.context import IHostContext
-from starlette.responses import Response
+from ellar.common import IExceptionHandler, IHostContext, Response
 
 class MyCustomException(Exception):
     pass
@@ -147,7 +145,8 @@ that will handler the current request.
 
 ```python
 import typing
-from ellar.core import HostContext, ControllerBase
+from ellar.common import ControllerBase
+from ellar.core import HostContext
 
 
 class ExecutionContext(HostContext):
@@ -196,8 +195,7 @@ We can then access this metadata from within our class to make certain decisions
 ```python
 # project_name/apps/cars/controllers.py
 
-from ellar.common import Body, Controller, post, set_metadata
-from ellar.core import ControllerBase
+from ellar.common import Body, Controller, post, set_metadata, ControllerBase
 from .schemas import CreateCarSerializer
 
 
@@ -218,8 +216,7 @@ Instead, create your own decorators, as shown below:
 ```python
 # project_name/apps/cars/controllers.py
 import typing
-from ellar.common import Body, Controller, post, set_metadata
-from ellar.core import ControllerBase
+from ellar.common import Body, Controller, post, set_metadata, ControllerBase
 from .schemas import CreateCarSerializer
 
 
@@ -246,8 +243,8 @@ To access the route's role(s) (custom metadata), we'll use the `Reflector` helpe
 ```python
 # project_name/apps/cars/guards.py
 from ellar.di import injectable
-from ellar.core import GuardCanActivate, IExecutionContext
-from ellar.services import Reflector
+from ellar.common import GuardCanActivate, IExecutionContext
+from ellar.core.services import Reflector
 
 
 @injectable()
@@ -269,8 +266,7 @@ Next, we apply the `RoleGuard` to `CarController`
 ```python
 # project_name/apps/cars/controllers.py
 import typing
-from ellar.common import Body, Controller, post, set_metadata, Guards
-from ellar.core import ControllerBase
+from ellar.common import Body, Controller, post, set_metadata, Guards, ControllerBase
 from .schemas import CreateCarSerializer
 from .guards import RoleGuard
 

docs/basics/testing.md

@@ -155,9 +155,8 @@ In same way, we can override `Guards` used in controllers during testing. For ex
 
 ```python
 import typing
-from ellar.compatible.dict import AttributeDict
-from ellar.common import Guards, Controller
-from ellar.core import ControllerBase
+from ellar.common.compatible import AttributeDict
+from ellar.common import Guards, Controller, ControllerBase
 from ellar.core.guard import HttpBearerAuth
 from ellar.di import injectable
 
@@ -314,11 +313,9 @@ Let's see how we can use `TestClient` in writing e2e testing for `CarController`
 
 ```python
 # project_name/car/tests/test_controllers.py
-from unittest.mock import patch
 from ellar.di import ProviderConfig
 from ellar.testing import Test, TestClient
 from project_name.apps.car.controllers import CarController
-from project_name.apps.car.schemas import CreateCarSerializer, CarListFilter
 from project_name.apps.car.services import CarRepository
 
 

docs/basics/versioning.md

@@ -21,7 +21,7 @@ To enable **URL Versioning** for your application, do the following:
 ```python
 # project_name/server.py
 import os
-from ellar.constants import ELLAR_CONFIG_MODULE
+from ellar.common.constants import ELLAR_CONFIG_MODULE
 from ellar.core.factory import AppFactory
 from ellar.core.versioning import VersioningSchemes
 from .root_module import ApplicationModule
@@ -55,7 +55,7 @@ To enable **Header Versioning** for your application, do the following:
 ```python
 # project_name/server.py
 import os
-from ellar.constants import ELLAR_CONFIG_MODULE
+from ellar.common.constants import ELLAR_CONFIG_MODULE
 from ellar.core.factory import AppFactory
 from ellar.core.versioning import VersioningSchemes
 from .root_module import ApplicationModule
@@ -110,7 +110,7 @@ To enable **Query Versioning** for your application, do the following:
 ```python
 # project_name/server.py
 import os
-from ellar.constants import ELLAR_CONFIG_MODULE
+from ellar.common.constants import ELLAR_CONFIG_MODULE
 from ellar.core.factory import AppFactory
 from ellar.core.versioning import VersioningSchemes
 from .root_module import ApplicationModule
@@ -143,7 +143,7 @@ To enable **Host Versioning** for your application, do the following:
 ```python
 # project_name/server.py
 import os
-from ellar.constants import ELLAR_CONFIG_MODULE
+from ellar.common.constants import ELLAR_CONFIG_MODULE
 from ellar.core.factory import AppFactory
 from ellar.core.versioning import VersioningSchemes
 from .root_module import ApplicationModule

docs/caching.md

@@ -457,7 +457,7 @@ Here's an example of how to use a custom `make_key_callback` function with the c
     ```python
     from ellar.common import get, cache
     from ellar.core import ExecutionContext
-    from ellar.helper import get_name
+    from ellar.common.helper import get_name
 
     def make_key_function(ctx: ExecutionContext, key_prefix: str) -> str:
         function_name = get_name(ctx.get_handler())
@@ -477,7 +477,7 @@ Here's an example of how to use a custom `make_key_callback` function with the c
     ```python
     from ellar.common import get, cache
     from ellar.core import ExecutionContext
-    from ellar.helper import get_name
+    from ellar.common.helper import get_name
 
     def make_key_function(ctx: ExecutionContext, key_prefix: str) -> str:
         function_name = get_name(ctx.get_handler())

docs/configurations.md

@@ -32,14 +32,14 @@ When turned on, `injector` can automatically bind to missing types as `singleton
 And when turned off, missing types will raise an `UnsatisfiedRequirement` exception.
 
 ### **DEFAULT_JSON_CLASS**
-Default: `JSONResponse` - (`starlette.response.JSONResponse`)
+Default: `JSONResponse` - (`starlette.common.JSONResponse`)
 
 **DEFAULT_JSON_CLASS** is used when sending JSON response to the client.
 
 There are other options for JSON available in Ellar:
 
-- **UJSONResponse**(`ellar.core.response.UJSONResponse`):  renders JSON response using [ujson](https://pypi.python.org/pypi/ujson). 
-- **ORJSONResponse**(`ellar.core.response.ORJSONResponse`):  renders JSON response using [orjson](https://pypi.org/project/orjson/). 
+- **UJSONResponse**(`ellar.common.UJSONResponse`):  renders JSON response using [ujson](https://pypi.python.org/pypi/ujson). 
+- **ORJSONResponse**(`ellar.common.ORJSONResponse`):  renders JSON response using [orjson](https://pypi.org/project/orjson/). 
 
 ### **JINJA_TEMPLATES_OPTIONS**
 Default: `{}`
@@ -152,10 +152,10 @@ Default: `not_found` (`not_found(scope: TScope, receive: TReceive, send: TSend)`
 Default is an ASGI function. **DEFAULT_NOT_FOUND_HANDLER** is used by the application router as a callback function to a resource not found.
 
 ```python
-from ellar.types import TScope, TReceive, TSend
+from ellar.common.types import TScope, TReceive, TSend
 from starlette.exceptions import HTTPException as StarletteHTTPException
 from starlette.websockets import WebSocketClose
-from ellar.core.response import PlainTextResponse
+from ellar.common import PlainTextResponse
 
 
 async def _not_found(scope: TScope, receive: TReceive, send: TSend) -> None:

docs/handling-response/response-model.md

@@ -6,9 +6,7 @@ This response model holds information on the type of response to be returned.
 ```python
 # project_name/apps/items/controllers.py
 
-from ellar.core.serializer import Serializer
-from ellar.common import Controller, get
-from ellar.core import ControllerBase
+from ellar.common import Controller, get, Serializer, ControllerBase
 
 class UserSchema(Serializer):
     username: str
@@ -30,8 +28,8 @@ During route response computation, the `me` route handler response will evaluate
 The resulting route responses will be:
 
 ```python
-from ellar.core.serializer import Serializer
-from ellar.core.response.model import JSONResponseModel
+from ellar.common import Serializer
+from ellar.common.responses.models import JSONResponseModel
 
 
 class UserSchema(Serializer):
@@ -73,10 +71,7 @@ For example:
 ```python
 # project_name/apps/items/controllers.py
 
-from ellar.common import Controller, get
-from ellar.core import ControllerBase
-from starlette.responses import PlainTextResponse
-from ellar.core.serializer import Serializer
+from ellar.common import Controller, get, ControllerBase,PlainTextResponse, Serializer
 
 
 class UserSchema(Serializer):
@@ -95,8 +90,8 @@ class ItemsController(ControllerBase):
 This will be translated to:
 
 ```python
-from ellar.core.response.model import ResponseModel, JSONResponseModel
-from starlette.responses import PlainTextResponse
+from ellar.common.responses.models import ResponseModel, JSONResponseModel
+from ellar.common import PlainTextResponse
 
 response = {200: ResponseModel(response_type=PlainTextResponse), 201: JSONResponseModel(model_field_or_schema=UserSchema)}
 ```
@@ -109,8 +104,7 @@ All response model follows `IResponseModel` contract.
 import typing as t
 
 from pydantic.fields import ModelField
-from ellar.core.context import IExecutionContext
-from ellar.core.response import Response
+from ellar.common import IExecutionContext, Response
 
 
 class IResponseModel:
@@ -197,10 +191,8 @@ Lets create a new JSON response model.
 # project_name/apps/items/controllers.py
 
 import typing as t
-from ellar.common import Controller, get
-from ellar.core import ControllerBase
-from ellar.core.response.model.base import ResponseModel
-from ellar.core.response import JSONResponse
+from ellar.common import Controller, get, ControllerBase, JSONResponse
+from ellar.common.responses.models import ResponseModel
 from dataclasses import dataclass
 
 

docs/handling-response/response.md

@@ -5,7 +5,7 @@ To use `Serializer` in Ellar, you simply need to create a class that inherits fr
 Here's an example of how you could define a serializer class for a user model:
 
 ```python
-from ellar.core.serializer import Serializer
+from ellar.common import Serializer
 
 class UserSerializer(Serializer):
     name: str
@@ -27,9 +27,7 @@ For example:
 ```python
 # project_name/apps/items/controllers.py
 
-from ellar.core.serializer import Serializer
-from ellar.common import Controller, get
-from ellar.core import ControllerBase
+from ellar.common import Controller, get, Serializer, ControllerBase
 
 # Define a User class with username, email, first_name, and last_name attributes
 class User:
@@ -80,7 +78,7 @@ For instance, we can convert the `UserSchema` to a dataclass by defining `UserDa
 
 ```python
 from dataclasses import dataclass
-from ellar.core.serializer import DataclassSerializer
+from ellar.common import DataclassSerializer
 
 
 @dataclass
@@ -101,9 +99,7 @@ The `response` parameter takes different shape. Let's see how to return a differ
 ```python
 # project_name/apps/items/controllers.py
 
-from ellar.core.serializer import Serializer
-from ellar.common import Controller, get
-from ellar.core import ControllerBase
+from ellar.common import Controller, get, ControllerBase, Serializer
 
 class User:
     def __init__(self, username: str, email:str=None, first_name:str=None, last_name:str=None) -> None:
@@ -167,9 +163,7 @@ You can use `Response` type to change the format of data returned from endpoint
 ```python
 # project_name/apps/items/controllers.py
 
-from ellar.common import Controller, get
-from ellar.core import ControllerBase
-from starlette.responses import PlainTextResponse
+from ellar.common import Controller, get, ControllerBase, PlainTextResponse
 
 
 @Controller
@@ -185,10 +179,7 @@ Also, we can return response object from endpoint functions, and it will overrid
 ```python
 # project_name/apps/items/controllers.py
 
-from ellar.core.serializer import Serializer
-from ellar.common import Controller, get
-from ellar.core import ControllerBase
-from starlette.responses import PlainTextResponse
+from ellar.common import Controller, get, Serializer, ControllerBase, PlainTextResponse
 
 class UserSchema(Serializer):
     username: str

docs/img/live_support_websocket_3.gif

@@ -1,3 +1,4 @@
+# **[ellar](#introduction)**
 <p align="center">
   <a href="#" target="blank"><img src="img/EllarLogoB.png" width="200" alt="Ellar Logo" /></a>
 </p>