diff --git a/README.md b/README.md index 6298bf5..5834585 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- Ellar Logo + Ellar Logo

![Test](https://github.com/python-ellar/ellar-sql/actions/workflows/test_full.yml/badge.svg) diff --git a/docs/img/ellar_sql.png b/docs/img/ellar_sql.png new file mode 100644 index 0000000..9439b50 Binary files /dev/null and b/docs/img/ellar_sql.png differ diff --git a/docs/index.md b/docs/index.md index 7de8281..9fa9bf0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ .md-content .md-typeset h1 { display: none; }

- Ellar Logo + Ellar Logo

EllarSQL is an SQL database Ellar Module.

@@ -48,6 +48,12 @@ EllarSQL core dependencies includes: pip install ellar-sql ``` +OR if you intend to work with **Async SQLAlchemy** packages, then: + +```shell +pip install ellar-sql[async] +``` + ## **Quick Example** Let's create a simple `User` model. ```python diff --git a/ellar_sql/__init__.py b/ellar_sql/__init__.py index 04c3003..514f849 100644 --- a/ellar_sql/__init__.py +++ b/ellar_sql/__init__.py @@ -1,6 +1,6 @@ """EllarSQL Module adds support for SQLAlchemy and Alembic package to your Ellar application""" -__version__ = "0.0.4" +__version__ = "0.0.6" from .model.database_binds import get_all_metadata, get_metadata from .module import EllarSQLModule diff --git a/mkdocs.yml b/mkdocs.yml index 3360e2d..777c3c4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -50,8 +50,8 @@ theme: text: Source Sans Pro code: Fira Code language: en - logo: img/EllarLogoB.png - favicon: img/Icon.svg + logo: img/ellar_sql.png + favicon: img/ellar_sql.png icon: repo: fontawesome/brands/git-alt diff --git a/pyproject.toml b/pyproject.toml index 4c50a6f..e2a7e93 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -37,6 +37,11 @@ dependencies = [ "alembic >= 1.10.0" ] +[project.optional-dependencies] +async = [ + "sqlalchemy[async] >= 2.0.23" +] + [project.urls] Documentation = "https://github.com/python-ellar/ellar-sql" Source = "https://github.com/python-ellar/ellar-sql" diff --git a/requirements-tests.txt b/requirements-tests.txt index ea6dcc4..5443019 100644 --- a/requirements-tests.txt +++ b/requirements-tests.txt @@ -3,6 +3,7 @@ anyio[trio] >= 3.2.1 autoflake ellar-cli >= 0.3.7 factory-boy >= 3.3.0 +httpx mypy == 1.8.0 pytest >= 7.1.3,< 9.0.0 pytest-asyncio diff --git a/requirements.txt b/requirements.txt index 8abc45a..f939878 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ --e . +-e .[async] -r requirements-docs.txt -r requirements-tests.txt