sqlalchemy-dlock 0.3__tar.gz → 0.4__tar.gz

{sqlalchemy-dlock-0.3 → sqlalchemy-dlock-0.4}/CHANGELOG.md

@@ -1,5 +1,29 @@
 # CHANGELOG
 
+## v0.4
+
+Date: 2023-06-17
+
+- Remove:
+  - remove `acquired` property, it's alias of `locked`
+  - remove setter of `locked` property
+
+- Optimize:
+  - re-arrange package's structure
+  - Many optimizations
+
+- CI/Test:
+  - Github action: Python 3.8~3.11 x SQLAlchemy 1.x/2.x matrix testing
+  - Local compose: Python 3.7~3.11 x SQLAlchemy 1.x/2.x matrix testing
+
+- Doc: Update to Sphinx 7.x, and Furo theme
+
+## v0.3.1
+
+Date: 2023-06-13
+
+- A hotfix for project's dependencies setup error.
+
 ## v0.3
 
 Date: 2023-06-13

sqlalchemy-dlock-0.4/MANIFEST.in

@@ -0,0 +1,8 @@
+exclude .*
+exclude *.docker-compose.yml
+exclude codecov.yml
+
+prune .*
+prune docs
+prune tests
+prune scripts

{sqlalchemy-dlock-0.3 → sqlalchemy-dlock-0.4}/PKG-INFO

@@ -1,39 +1,11 @@
 Metadata-Version: 2.1
 Name: sqlalchemy-dlock
-Version: 0.3
+Version: 0.4
 Summary: A distributed lock implementation based on SQLAlchemy
 Author-email: liu xue yan <liu_xue_yan@foxmail.com>
-License: BSD 3-Clause License
-        
-        Copyright (c) 2020, liu xue yan
-        All rights reserved.
-        
-        Redistribution and use in source and binary forms, with or without
-        modification, are permitted provided that the following conditions are met:
-        
-        1. Redistributions of source code must retain the above copyright notice, this
-           list of conditions and the following disclaimer.
-        
-        2. Redistributions in binary form must reproduce the above copyright notice,
-           this list of conditions and the following disclaimer in the documentation
-           and/or other materials provided with the distribution.
-        
-        3. Neither the name of the copyright holder nor the names of its
-           contributors may be used to endorse or promote products derived from
-           this software without specific prior written permission.
-        
-        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-        
+License: BSD-3-Clause
 Project-URL: homepage, https://github.com/tanbro/sqlalchemy-dlock
+Project-URL: documentation, https://sqlalchemy-dlock.readthedocs.io/
 Project-URL: repository, https://github.com/tanbro/sqlalchemy-dlock.git
 Keywords: SQLAlchemy,lock,distributed,distributed lock,SQL,database,DBMS
 Classifier: License :: OSI Approved :: BSD License
@@ -43,6 +15,15 @@ Classifier: Programming Language :: Python
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 Provides-Extra: asyncio
+Provides-Extra: mysqlclient
+Provides-Extra: pymysql
+Provides-Extra: aiomysql
+Provides-Extra: psycopg2
+Provides-Extra: psycopg2-binary
+Provides-Extra: psycopg3
+Provides-Extra: psycopg3-binary
+Provides-Extra: psycopg3-c
+Provides-Extra: asyncpg3
 License-File: LICENSE
 License-File: AUTHORS.md
 
@@ -62,7 +43,13 @@ It currently supports below locks:
 MySQL      | [named lock](https://dev.mysql.com/doc/refman/8.0/en/locking-functions.html)
 PostgreSQL | [advisory lock](https://www.postgresql.org/docs/current/explicit-locking.html#ADVISORY-LOCKS)
 
-## Usages
+## Install
+
+```bash
+pip install sqlalchemy-dlock
+```
+
+## Usage
 
 - Work with [SQLAlchemy][] `Connection`:
 
@@ -72,22 +59,22 @@ PostgreSQL | [advisory lock](https://www.postgresql.org/docs/current/explicit-lo
 
   key = 'user/001'
 
-  engine = create_engine('postgresql://scott:tiger@localhost/')
+  engine = create_engine('postgresql://scott:tiger@127.0.0.1/')
   conn = engine.connect()
 
   # Create the D-Lock on the connection
   lock = create_sadlock(conn, key)
 
   # it's not lock when constructed
-  assert not lock.acquired
+  assert not lock.locked
 
   # lock
   lock.acquire()
-  assert lock.acquired
+  assert lock.locked
 
   # un-lock
   lock.release()
-  assert not lock.acquired
+  assert not lock.locked
   ```
 
 - `with` statement
@@ -100,27 +87,27 @@ PostgreSQL | [advisory lock](https://www.postgresql.org/docs/current/explicit-lo
 
   key = 'user/001'
 
-  engine = create_engine('postgresql://scott:tiger@localhost/')
+  engine = create_engine('postgresql://scott:tiger@127.0.0.1/')
   with engine.connect() as conn:
 
       # Create the D-Lock on the connection
       with create_sadlock(conn, key) as lock:
           # It's locked
-          assert lock.acquired
+          assert lock.locked
 
       # Auto un-locked
-      assert not lock.acquired
+      assert not lock.locked
 
       # If do not want to be locked in `with`, a `closing` wrapper may help
       with closing(create_sadlock(conn, key)) as lock2:
-          # It's NOT locked here
-          assert not lock2.acquired
+          # It's NOT locked here !!!
+          assert not lock2.locked
           # lock it now:
           lock2.acquire()
-          assert lock2.acquired
+          assert lock2.locked
 
       # Auto un-locked
-      assert not lock2.acquired
+      assert not lock2.locked
   ```
 
 - Work with [SQLAlchemy][] `ORM` session:
@@ -132,18 +119,18 @@ PostgreSQL | [advisory lock](https://www.postgresql.org/docs/current/explicit-lo
 
   key = 'user/001'
 
-  engine = create_engine('postgresql://scott:tiger@localhost/')
+  engine = create_engine('postgresql://scott:tiger@127.0.0.1/')
   Session = sessionmaker(bind=engine)
 
   with Session() as session:
     with create_sadlock(session, key) as lock:
-        assert lock.acquired
-    assert not lock.acquired
+        assert lock.locked
+    assert not lock.locked
   ```
 
 - Asynchronous I/O Support
 
-  > ℹ️ **info**:
+  > **Note**:
   >
   > - [SQLAlchemy][] `1.x`: <https://docs.sqlalchemy.org/14/orm/extensions/asyncio.html>
   > - [SQLAlchemy][] `2.x`: <https://docs.sqlalchemy.org/20/orm/extensions/asyncio.html>
@@ -154,7 +141,7 @@ PostgreSQL | [advisory lock](https://www.postgresql.org/docs/current/explicit-lo
 
   key = 'user/001'
 
-  engine = create_async_engine('postgresql+asyncpg://scott:tiger@localhost/')
+  engine = create_async_engine('postgresql+asyncpg://scott:tiger@127.0.0.1/')
 
   async with engine.begin() as conn:
       async with create_async_sadlock(conn, key) as lock:
@@ -165,42 +152,65 @@ PostgreSQL | [advisory lock](https://www.postgresql.org/docs/current/explicit-lo
       assert not lock.locked
   ```
 
-## Tests
+  > **Note**:
+  >
+  > [aiomysql][], [asyncpg][] and [psycopg][] are tested asynchronous drivers
+  >
+  > We can install asynchronous DB libraries like one of blows:
+  >
+  > - ```bash
+  >   pip install sqlalchemy-dlock[asyncpg]
+  >   ```
+  >
+  > - ```bash
+  >   pip install sqlalchemy-dlock[asyncio] aiomysql
+  >   ```
+  >
+  > - ```bash
+  >   pip install SQLALchemy[asyncio] sqlalchemy-dlock psycopg
+  >   ```
+
+## Test
 
-Following [SQLAlchemy][] engines are tested:
+Following drivers are tested:
 
 - MySQL:
+  - [mysqlclient][] (synchronous)
+  - [pymysql][] (synchronous)
+  - [aiomysql][] (asynchronous)
+- Postgres:
+  - [psycopg2][] (asynchronous)
+  - [asyncpg][] (asynchronous)
+  - [psycopg][] (synchronous and asynchronous)
 
-  - mysqlclient
-  - PyMySQL
-  - aiomysql ([asyncio][])
+You can run unit-tests
 
-- Postgres:
+- on local environment:
 
-  - psycopg2
-  - asyncpg ([asyncio][])
+  1. Install the project with drivers and `asyncio` extra requires, a virtual environment ([venv][]) is strongly advised:
 
-You can run unit-tests:
+     ```bash
+     pip install -e .[mysqlclient psycopg2-binary aiomysql asyncpg]
+     ```
 
-- directly:
+  1. start up mysql and postgresql
 
-  1. Install the project (A virtual environment ([venv][]) is strongly advised):
+     There is a docker [compose][] file `db.docker-compose.yml` in the project dir,
+     which can be used to run mysql and postgresql develop environment conveniently:
 
      ```bash
-     pip install -e .
+     docker compose -f db.docker-compose.yml up
      ```
 
-  1. Start up your mysql and postgresql
-
-  1. Set environment variables `TEST_URLS` and `TEST_ASYNC_URLS` for sync and async database connection url.
+  1. set environment variables `TEST_URLS` and `TEST_ASYNC_URLS` for sync and async database connection url.
      Multiple connections separated by space.
      The test cases load environment variables in `tests/.env`.
 
      eg (and also the defaults):
 
      ```ini
-     TEST_URLS=mysql://test:test@localhost/test postgresql://postgres:test@localhost/
-     TEST_ASYNC_URLS=mysql+aiomysql://test:test@localhost/test postgresql+asyncpg://postgres:test@localhost/
+     TEST_URLS=mysql://test:test@127.0.0.1/test postgresql://postgres:test@127.0.0.1/
+     TEST_ASYNC_URLS=mysql+aiomysql://test:test@127.0.0.1/test postgresql+asyncpg://postgres:test@127.0.0.1/
      ```
 
   1. run unit-test
@@ -209,7 +219,7 @@ You can run unit-tests:
      python -m unittest
      ```
 
-- in docker-compose:
+- or on docker-compose:
 
   1. build the project
 
@@ -219,12 +229,30 @@ You can run unit-tests:
 
   1. run unit-test
 
+     Name of services for Python and [SQLAlchemy][] version matrix in the [compose][] file has such format:
+
+         python{{X.Y}}-sqlalchemy{{X}}
+
+     For example, if want to take a test for Python `3.9` and [SQLAlchemy][] `2.x`, we shall up to run unit-tests as below:
+
+     ```bash
+     cd tests
+     docker compose up python3.9-sqlalchemy2
+     ```
+
+     For Python `3.8` and [SQLAlchemy][] `1.x`:
+
      ```bash
      cd tests
-     docker compose up --abort-on-container-exit
-     docker compose rm -fsv
+     docker compose up python3.8-sqlalchemy1
      ```
 
 [SQLAlchemy]: https://www.sqlalchemy.org/ "The Python SQL Toolkit and Object Relational Mapper"
-[asyncio]: https://docs.python.org/library/asyncio.html "asyncio is a library to write concurrent code using the async/await syntax."
 [venv]: https://docs.python.org/library/venv.html "The venv module supports creating lightweight “virtual environments”, each with their own independent set of Python packages installed in their site directories. "
+[mysqlclient]: https://pypi.org/project/mysqlclient/ "Python interface to MySQL"
+[psycopg2]: https://pypi.org/project/psycopg2/ "PostgreSQL database adapter for Python"
+[psycopg]: https://pypi.org/project/psycopg/ "Psycopg 3 is a modern implementation of a PostgreSQL adapter for Python."
+[aiomysql]: https://pypi.org/project/aiomysql/ "aiomysql is a “driver” for accessing a MySQL database from the asyncio (PEP-3156/tulip) framework."
+[asyncpg]: https://pypi.org/project/asyncpg/ "asyncpg is a database interface library designed specifically for PostgreSQL and Python/asyncio. "
+[pymysql]: https://pypi.org/project/pymysql/ "Pure Python MySQL Driver"
+[compose]: https://docs.docker.com/compose/ "Compose is a tool for defining and running multi-container Docker applications."

{sqlalchemy-dlock-0.3 → sqlalchemy-dlock-0.4}/README.md

@@ -14,7 +14,13 @@ It currently supports below locks:
 MySQL      | [named lock](https://dev.mysql.com/doc/refman/8.0/en/locking-functions.html)
 PostgreSQL | [advisory lock](https://www.postgresql.org/docs/current/explicit-locking.html#ADVISORY-LOCKS)
 
-## Usages
+## Install
+
+```bash
+pip install sqlalchemy-dlock
+```
+
+## Usage
 
 - Work with [SQLAlchemy][] `Connection`:
 
@@ -24,22 +30,22 @@ PostgreSQL | [advisory lock](https://www.postgresql.org/docs/current/explicit-lo
 
   key = 'user/001'
 
-  engine = create_engine('postgresql://scott:tiger@localhost/')
+  engine = create_engine('postgresql://scott:tiger@127.0.0.1/')
   conn = engine.connect()
 
   # Create the D-Lock on the connection
   lock = create_sadlock(conn, key)
 
   # it's not lock when constructed
-  assert not lock.acquired
+  assert not lock.locked
 
   # lock
   lock.acquire()
-  assert lock.acquired
+  assert lock.locked
 
   # un-lock
   lock.release()
-  assert not lock.acquired
+  assert not lock.locked
   ```
 
 - `with` statement
@@ -52,27 +58,27 @@ PostgreSQL | [advisory lock](https://www.postgresql.org/docs/current/explicit-lo
 
   key = 'user/001'
 
-  engine = create_engine('postgresql://scott:tiger@localhost/')
+  engine = create_engine('postgresql://scott:tiger@127.0.0.1/')
   with engine.connect() as conn:
 
       # Create the D-Lock on the connection
       with create_sadlock(conn, key) as lock:
           # It's locked
-          assert lock.acquired
+          assert lock.locked
 
       # Auto un-locked
-      assert not lock.acquired
+      assert not lock.locked
 
       # If do not want to be locked in `with`, a `closing` wrapper may help
       with closing(create_sadlock(conn, key)) as lock2:
-          # It's NOT locked here
-          assert not lock2.acquired
+          # It's NOT locked here !!!
+          assert not lock2.locked
           # lock it now:
           lock2.acquire()
-          assert lock2.acquired
+          assert lock2.locked
 
       # Auto un-locked
-      assert not lock2.acquired
+      assert not lock2.locked
   ```
 
 - Work with [SQLAlchemy][] `ORM` session:
@@ -84,18 +90,18 @@ PostgreSQL | [advisory lock](https://www.postgresql.org/docs/current/explicit-lo
 
   key = 'user/001'
 
-  engine = create_engine('postgresql://scott:tiger@localhost/')
+  engine = create_engine('postgresql://scott:tiger@127.0.0.1/')
   Session = sessionmaker(bind=engine)
 
   with Session() as session:
     with create_sadlock(session, key) as lock:
-        assert lock.acquired
-    assert not lock.acquired
+        assert lock.locked
+    assert not lock.locked
   ```
 
 - Asynchronous I/O Support
 
-  > ℹ️ **info**:
+  > **Note**:
   >
   > - [SQLAlchemy][] `1.x`: <https://docs.sqlalchemy.org/14/orm/extensions/asyncio.html>
   > - [SQLAlchemy][] `2.x`: <https://docs.sqlalchemy.org/20/orm/extensions/asyncio.html>
@@ -106,7 +112,7 @@ PostgreSQL | [advisory lock](https://www.postgresql.org/docs/current/explicit-lo
 
   key = 'user/001'
 
-  engine = create_async_engine('postgresql+asyncpg://scott:tiger@localhost/')
+  engine = create_async_engine('postgresql+asyncpg://scott:tiger@127.0.0.1/')
 
   async with engine.begin() as conn:
       async with create_async_sadlock(conn, key) as lock:
@@ -117,42 +123,65 @@ PostgreSQL | [advisory lock](https://www.postgresql.org/docs/current/explicit-lo
       assert not lock.locked
   ```
 
-## Tests
+  > **Note**:
+  >
+  > [aiomysql][], [asyncpg][] and [psycopg][] are tested asynchronous drivers
+  >
+  > We can install asynchronous DB libraries like one of blows:
+  >
+  > - ```bash
+  >   pip install sqlalchemy-dlock[asyncpg]
+  >   ```
+  >
+  > - ```bash
+  >   pip install sqlalchemy-dlock[asyncio] aiomysql
+  >   ```
+  >
+  > - ```bash
+  >   pip install SQLALchemy[asyncio] sqlalchemy-dlock psycopg
+  >   ```
+
+## Test
 
-Following [SQLAlchemy][] engines are tested:
+Following drivers are tested:
 
 - MySQL:
+  - [mysqlclient][] (synchronous)
+  - [pymysql][] (synchronous)
+  - [aiomysql][] (asynchronous)
+- Postgres:
+  - [psycopg2][] (asynchronous)
+  - [asyncpg][] (asynchronous)
+  - [psycopg][] (synchronous and asynchronous)
 
-  - mysqlclient
-  - PyMySQL
-  - aiomysql ([asyncio][])
+You can run unit-tests
 
-- Postgres:
+- on local environment:
 
-  - psycopg2
-  - asyncpg ([asyncio][])
+  1. Install the project with drivers and `asyncio` extra requires, a virtual environment ([venv][]) is strongly advised:
 
-You can run unit-tests:
+     ```bash
+     pip install -e .[mysqlclient psycopg2-binary aiomysql asyncpg]
+     ```
 
-- directly:
+  1. start up mysql and postgresql
 
-  1. Install the project (A virtual environment ([venv][]) is strongly advised):
+     There is a docker [compose][] file `db.docker-compose.yml` in the project dir,
+     which can be used to run mysql and postgresql develop environment conveniently:
 
      ```bash
-     pip install -e .
+     docker compose -f db.docker-compose.yml up
      ```
 
-  1. Start up your mysql and postgresql
-
-  1. Set environment variables `TEST_URLS` and `TEST_ASYNC_URLS` for sync and async database connection url.
+  1. set environment variables `TEST_URLS` and `TEST_ASYNC_URLS` for sync and async database connection url.
      Multiple connections separated by space.
      The test cases load environment variables in `tests/.env`.
 
      eg (and also the defaults):
 
      ```ini
-     TEST_URLS=mysql://test:test@localhost/test postgresql://postgres:test@localhost/
-     TEST_ASYNC_URLS=mysql+aiomysql://test:test@localhost/test postgresql+asyncpg://postgres:test@localhost/
+     TEST_URLS=mysql://test:test@127.0.0.1/test postgresql://postgres:test@127.0.0.1/
+     TEST_ASYNC_URLS=mysql+aiomysql://test:test@127.0.0.1/test postgresql+asyncpg://postgres:test@127.0.0.1/
      ```
 
   1. run unit-test
@@ -161,7 +190,7 @@ You can run unit-tests:
      python -m unittest
      ```
 
-- in docker-compose:
+- or on docker-compose:
 
   1. build the project
 
@@ -171,12 +200,30 @@ You can run unit-tests:
 
   1. run unit-test
 
+     Name of services for Python and [SQLAlchemy][] version matrix in the [compose][] file has such format:
+
+         python{{X.Y}}-sqlalchemy{{X}}
+
+     For example, if want to take a test for Python `3.9` and [SQLAlchemy][] `2.x`, we shall up to run unit-tests as below:
+
+     ```bash
+     cd tests
+     docker compose up python3.9-sqlalchemy2
+     ```
+
+     For Python `3.8` and [SQLAlchemy][] `1.x`:
+
      ```bash
      cd tests
-     docker compose up --abort-on-container-exit
-     docker compose rm -fsv
+     docker compose up python3.8-sqlalchemy1
      ```
 
 [SQLAlchemy]: https://www.sqlalchemy.org/ "The Python SQL Toolkit and Object Relational Mapper"
-[asyncio]: https://docs.python.org/library/asyncio.html "asyncio is a library to write concurrent code using the async/await syntax."
 [venv]: https://docs.python.org/library/venv.html "The venv module supports creating lightweight “virtual environments”, each with their own independent set of Python packages installed in their site directories. "
+[mysqlclient]: https://pypi.org/project/mysqlclient/ "Python interface to MySQL"
+[psycopg2]: https://pypi.org/project/psycopg2/ "PostgreSQL database adapter for Python"
+[psycopg]: https://pypi.org/project/psycopg/ "Psycopg 3 is a modern implementation of a PostgreSQL adapter for Python."
+[aiomysql]: https://pypi.org/project/aiomysql/ "aiomysql is a “driver” for accessing a MySQL database from the asyncio (PEP-3156/tulip) framework."
+[asyncpg]: https://pypi.org/project/asyncpg/ "asyncpg is a database interface library designed specifically for PostgreSQL and Python/asyncio. "
+[pymysql]: https://pypi.org/project/pymysql/ "Pure Python MySQL Driver"
+[compose]: https://docs.docker.com/compose/ "Compose is a tool for defining and running multi-container Docker applications."

{sqlalchemy-dlock-0.3 → sqlalchemy-dlock-0.4}/pyproject.toml

@@ -1,45 +1,66 @@
 [build-system]
 build-backend = "setuptools.build_meta"
-requires = ["setuptools>=45", "wheel", "setuptools_scm>=6.2"]
+requires = ["setuptools>=61", "setuptools_scm>=6.2"]
 
 [project]
+name = "sqlalchemy-dlock"
+readme = {file = 'README.md', content-type = 'text/markdown'}
 authors = [
   {name = "liu xue yan", email = "liu_xue_yan@foxmail.com"},
 ]
+description = "A distributed lock implementation based on SQLAlchemy"
+keywords = ["SQLAlchemy", "lock", "distributed", "distributed lock", "SQL", "database", "DBMS"]
+license = {text = "BSD-3-Clause"}
 classifiers = [
   "License :: OSI Approved :: BSD License",
   "Topic :: Database :: Front-Ends",
   "Intended Audience :: Developers",
   "Programming Language :: Python",
 ]
-description = "A distributed lock implementation based on SQLAlchemy"
-keywords = ["SQLAlchemy", "lock", "distributed", "distributed lock", "SQL", "database", "DBMS"]
-license = {file = 'LICENSE'}
-name = "sqlalchemy-dlock"
-readme = {file = 'README.md', content-type = 'text/markdown'}
-requires-python = ">=3.7"
-
 dynamic = ["version"]
 
+# requires python version
+requires-python = ">=3.7"
+# requires
+dependencies = [
+  "SQLAlchemy>=1.4.3,<3.0",
+]
+# extra requires
+[project.optional-dependencies]
+# SQLAlchemy with asyncio, no engines
+asyncio = ["SQLAlchemy[asyncio]"]
+# MySQL
+mysqlclient = ["mysqlclient"]
+pymysql = ["pymysql"]
+# MySQL asyncio
+aiomysql = ["SQLAlchemy[asyncio]", "aiomysql"]
+# Postgres
+# psycopg2: sync
+psycopg2 = ["psycopg2>=2.8"] # psycopg2 compiling needed when install
+psycopg2-binary = ["psycopg2-binary>=2.8"] # psycopg2 with pre-compiled C library
+# psycopg3: both sync and asyncio
+psycopg3 = ["SQLAlchemy>=2.0", "psycopg"] # psycopg3 dynamik link to libpq
+psycopg3-binary = ["SQLAlchemy>=2.0", "psycopg[binary]"] # psycopg3 with pre-compiled C library
+psycopg3-c = ["SQLAlchemy>=2.0", "psycopg[c]"] # psycopg3 compiling needed when install
+# Postgres asyncio
+asyncpg3 = ["SQLAlchemy[asyncio]", "asyncpg"]
+
+# Project links
 [project.urls]
 homepage = "https://github.com/tanbro/sqlalchemy-dlock"
+documentation = "https://sqlalchemy-dlock.readthedocs.io/"
 repository = "https://github.com/tanbro/sqlalchemy-dlock.git"
 
-[tool.setuptools_scm]
-write_to = "src/sqlalchemy_dlock/version.py"
-
 [tool.setuptools.packages.find]
 where = ["src"]
 
-[tool.black]
-line-length = 127
-
-dependencies = [
-  "SQLAlchemy>=1.4,<3.0",
-]
+[tool.setuptools_scm]
+write_to = "src/sqlalchemy_dlock/version.py"
 
 [options.packages.find]
 where = "src"
 
-[project.optional-dependencies]
-asyncio = ["SQLAlchemy[asyncio]"]
+[tool.black]
+line-length = 127
+[tool.isort]
+profile = "black"

sqlalchemy-dlock-0.4/src/sqlalchemy_dlock/__init__.py

@@ -0,0 +1,7 @@
+"""
+Distributed lock based on Database and SQLAlchemy
+"""
+
+from .exceptions import *
+from .functions import *
+from .version import version as __version__