Merge pull request #9 from python-ellar/project_rename

Project Rename

Author: eadwinCode

.github/workflows/test_full.yml

@@ -38,6 +38,6 @@ jobs:
       - name: Install Dependencies
         run: flit install --symlink
       - name: Linting check
-        run: ruff check ellar_sqlalchemy tests
+        run: ruff check ellar_sql tests
       - name: mypy
-        run: mypy ellar_sqlalchemy
+        run: mypy ellar_sql

Makefile

@@ -19,20 +19,26 @@ install-full: ## Install dependencies
 	pre-commit install -f
 
 lint:fmt ## Run code linters
-	ruff check ellar_sqlalchemy tests
-	mypy ellar_sqlalchemy
+	ruff check ellar_sql tests
+	mypy ellar_sql
 
 fmt format:clean ## Run code formatters
-	ruff format ellar_sqlalchemy tests
-	ruff check --fix ellar_sqlalchemy tests
+	ruff format ellar_sql tests
+	ruff check --fix ellar_sql tests
 
 test: ## Run tests
 	pytest tests
 
 test-cov: ## Run tests with coverage
-	pytest --cov=ellar_sqlalchemy --cov-report term-missing tests
+	pytest --cov=ellar_sql --cov-report term-missing tests
 
 pre-commit-lint: ## Runs Requires commands during pre-commit
 	make clean
 	make fmt
 	make lint
+
+doc-deploy:clean ## Run Deploy Documentation
+	mkdocs gh-deploy --force --ignore-version
+
+doc-serve: ## Launch doc local server
+	mkdocs serve

README.md

@@ -52,7 +52,7 @@ Then, in `models/base.py` define your model base as shown below:
 from datetime import datetime
 from sqlalchemy import DateTime, func
 from sqlalchemy.orm import Mapped, mapped_column
-from ellar_sqlalchemy.model import Model
+from ellar_sql.model import Model
 
 
 class Base(Model):
@@ -89,7 +89,7 @@ from ellar.app import App
 from ellar.common import Module, IApplicationStartup
 from ellar.core import ModuleBase
 from ellar.di import Container
-from ellar_sqlalchemy import EllarSQLAlchemyModule, EllarSQLAlchemyService
+from ellar_sql import EllarSQLAlchemyModule, EllarSQLService
 
 from .controllers import DbController
 
@@ -116,7 +116,7 @@ class DbModule(ModuleBase, IApplicationStartup):
     """
 
     async def on_startup(self, app: App) -> None:
-        db_service = app.injector.get(EllarSQLAlchemyService)
+        db_service = app.injector.get(EllarSQLService)
         db_service.create_all()
 
     def register_providers(self, container: Container) -> None:

ellar_sqlalchemy/__init__.py renamed to ellar_sql/__init__.py

@@ -2,7 +2,7 @@
 
 __version__ = "0.0.1"
 
-from .module import EllarSQLAlchemyModule
+from .module import EllarSQLModule
 from .pagination import LimitOffsetPagination, PageNumberPagination, paginate
 from .query import (
     first_or_404,
@@ -13,11 +13,11 @@
     one_or_404_async,
 )
 from .schemas import MigrationOption, SQLAlchemyConfig
-from .services import EllarSQLAlchemyService
+from .services import EllarSQLService
 
 __all__ = [
-    "EllarSQLAlchemyModule",
-    "EllarSQLAlchemyService",
+    "EllarSQLModule",
+    "EllarSQLService",
     "SQLAlchemyConfig",
     "MigrationOption",
     "get_or_404_async",

ellar_sqlalchemy/cli/__init__.py renamed to ellar_sql/cli/__init__.py

@@ -1,13 +1,13 @@
 import ellar_cli.click as click
 from ellar.app import current_injector
 
-from ellar_sqlalchemy.services import EllarSQLAlchemyService
+from ellar_sql.services import EllarSQLService
 
 from .handlers import CLICommandHandlers
 
 
 def _get_handler_context(ctx: click.Context) -> CLICommandHandlers:
-    db_service = current_injector.get(EllarSQLAlchemyService)
+    db_service = current_injector.get(EllarSQLService)
     return CLICommandHandlers(db_service)
 
 

ellar_sqlalchemy/cli/commands.py renamed to ellar_sql/cli/commands.py

@@ -12,7 +12,7 @@
 from alembic.util.exc import CommandError
 from ellar.app import App
 
-from ellar_sqlalchemy.services import EllarSQLAlchemyService
+from ellar_sql.services import EllarSQLService
 
 RevIdType = t.Union[str, t.List[str], t.Tuple[str, ...]]
 
@@ -35,7 +35,7 @@ def wrapped(*args: t.Any, **kwargs: t.Any) -> None:
 
 
 class CLICommandHandlers:
-    def __init__(self, db_service: EllarSQLAlchemyService) -> None:
+    def __init__(self, db_service: EllarSQLService) -> None:
         self.db_service = db_service
 
     def get_config(