Added support for Table, refactored model creation and added tests

Author: eadwinCode

.github/workflows/publish.yml

@@ -18,8 +18,11 @@ jobs:
         run: pip install flit
       - name: Install Dependencies
         run: flit install --symlink
+      - name: Install build dependencies
+        run: pip install build
+      - name: Build distribution
+        run: python -m build
       - name: Publish
-        env:
-          FLIT_USERNAME: ${{ secrets.FLIT_USERNAME }}
-          FLIT_PASSWORD: ${{ secrets.FLIT_PASSWORD }}
-        run: flit publish
+        uses: pypa/[email protected]
+        with:
+          password: ${{ secrets.FLIT_PASSWORD }}

README.md

@@ -9,9 +9,20 @@
 [![PyPI version](https://img.shields.io/pypi/pyversions/ellar-sqlachemy.svg)](https://pypi.python.org/pypi/ellar-sqlachemy)
 
 ## Project Status
-- 70% done
-- Tests
-- Documentation
+[] Overall Completion - 80% done
+[] Tests - 90% Complete
+[x] Model class to create SQLAlchemy Models and Declarative Base
+[x] SQLAlchemy model export to dictionary through `model.dict(exclude={'x', 'y', 'z'})`
+[x] Support multiple database configuration in Models and in Query
+[x] Session to manage Model metadata
+[x] Service to manage Engine and Session creation and Migration initialization for async and sync Engines and Sessions
+[x] Alembic env.py with async first `run_migrations_online` action
+[x] Expose all alembic commands to Ellar CLI 
+[x] Module to config and setup SQLAlchemy dependencies and migration
+[] SQLAlchemy Pagination for both templating and api routes
+[x] File and Image SQLAlchemy Columns integrated with ellar storage
+[] SQLAlchemy Django Like Query
+[] Documentation
 
 ## Introduction
 Ellar SQLAlchemy Module simplifies the integration of SQLAlchemy and Alembic migration tooling into your ellar application.

ellar_sqlalchemy/__init__.py

@@ -3,6 +3,12 @@
 __version__ = "0.0.1"
 
 from .module import EllarSQLAlchemyModule
+from .schemas import MigrationOption, SQLAlchemyConfig
 from .services import EllarSQLAlchemyService
 
-__all__ = ["EllarSQLAlchemyModule", "EllarSQLAlchemyService"]
+__all__ = [
+    "EllarSQLAlchemyModule",
+    "EllarSQLAlchemyService",
+    "SQLAlchemyConfig",
+    "MigrationOption",
+]

ellar_sqlalchemy/cli/commands.py

@@ -1,22 +1,22 @@
-import click
+import ellar_cli.click as click
 from ellar.app import current_injector
 
 from ellar_sqlalchemy.services import EllarSQLAlchemyService
 
 from .handlers import CLICommandHandlers
 
 
+def _get_handler_context(ctx: click.Context) -> CLICommandHandlers:
+    db_service = current_injector.get(EllarSQLAlchemyService)
+    return CLICommandHandlers(db_service)
+
+
 @click.group()
 def db():
     """- Perform Alembic Database Commands -"""
     pass
 
 
-def _get_handler_context(ctx: click.Context) -> CLICommandHandlers:
-    db_service = current_injector.get(EllarSQLAlchemyService)
-    return CLICommandHandlers(db_service)
-
-
 @db.command()
 @click.option(
     "-d",
@@ -385,7 +385,21 @@ def stamp(ctx: click.Context, directory, sql, tag, revision):
     handler.stamp(directory, revision, sql, tag)
 
 
-@db.command("init-migration")
+@db.command()
+@click.option(
+    "-d",
+    "--directory",
+    default=None,
+    help='Migration script directory (default is "migrations")',
+)
+@click.pass_context
+def check(ctx: click.Context, directory):
+    """Check if there are any new operations to migrate"""
+    handler = _get_handler_context(ctx)
+    handler.check(directory)
+
+
+@db.command("init")
 @click.option(
     "-d",
     "--directory",

ellar_sqlalchemy/cli/handlers.py

@@ -1,21 +1,19 @@
 from __future__ import annotations
 
 import argparse
-import logging
 import os
-import sys
 import typing as t
 from functools import wraps
 from pathlib import Path
 
+import click
 from alembic import command
 from alembic.config import Config as AlembicConfig
 from alembic.util.exc import CommandError
 from ellar.app import App
 
 from ellar_sqlalchemy.services import EllarSQLAlchemyService
 
-log = logging.getLogger(__name__)
 RevIdType = t.Union[str, t.List[str], t.Tuple[str, ...]]
 
 
@@ -31,8 +29,7 @@ def wrapped(*args: t.Any, **kwargs: t.Any) -> None:
         try:
             f(*args, **kwargs)
         except (CommandError, RuntimeError) as exc:
-            log.error("Error: " + str(exc))
-            sys.exit(1)
+            raise click.ClickException(str(exc)) from exc
 
     return wrapped
 

ellar_sqlalchemy/exceptions.py

@@ -0,0 +1,6 @@
+# class NoMatch(Exception):
+#     pass
+#
+#
+# class MultipleMatches(Exception):
+#     pass

ellar_sqlalchemy/model/__init__.py

@@ -1,12 +1,52 @@
+import typing as t
+
+import sqlalchemy as sa
+import sqlalchemy.event as sa_event
+import sqlalchemy.orm as sa_orm
+
 from .base import Model
 from .table import Table
-from .typeDecorator import GUID, GenericIP
+from .typeDecorator import (
+    GUID,
+    CroppingDetails,
+    FileField,
+    FileObject,
+    GenericIP,
+    ImageFileField,
+    ImageFileObject,
+)
 from .utils import make_metadata
 
+if t.TYPE_CHECKING:
+    from sqlalchemy import *  # type:ignore[assignment]
+    from sqlalchemy.event import *  # noqa
+    from sqlalchemy.orm import *  # noqa
+
+    from .table import Table  # noqa
+
 __all__ = [
     "Model",
     "Table",
     "make_metadata",
     "GUID",
     "GenericIP",
+    "FileObject",
+    "FileField",
+    "ImageFileField",
+    "ImageFileObject",
+    "CroppingDetails",
 ]
+
+
+def __getattr__(name: str) -> t.Any:
+    if name == "event":
+        return sa_event
+
+    if name.startswith("_"):
+        raise AttributeError(name)
+
+    for mod in (sa, sa_orm):
+        if hasattr(mod, name):
+            return getattr(mod, name)
+
+    raise AttributeError(name)