From 9f05e7d0d26bff062c185f1ac63a781991439675 Mon Sep 17 00:00:00 2001 From: jason810496 <810496@email.wlsh.tyc.edu.tw> Date: Mon, 22 Jul 2024 01:01:19 +0800 Subject: [PATCH 1/4] doc(fix): fix RTD links and `pip install` command --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index baa816b..89d008a 100644 --- a/README.md +++ b/README.md @@ -42,9 +42,9 @@ pip install pgmq-sqlalchemy Install with additional DBAPIs packages: ```bash -pip install pgmq-sqlalchemy[psycopg2] -pip install pgmq-sqlalchemy[asyncpg] -# pip install pgmq-sqlalchemy[postgres-python-driver] +pip install "pgmq-sqlalchemy[asyncpg]" +pip install "pgmq-sqlalchemy[psycopg2-binary]" +# pip install "pgmq-sqlalchemy[postgres-python-driver]" ``` ## Getting Started @@ -61,7 +61,7 @@ docker run -d --name postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 quay.io ### Usage > [!NOTE] -> Check [pgmq-sqlalchemy Document](https://pgmq-sqlalchemy-python.readthedocs.io/en/latest/) for more examples and detailed usage. +> Check [pgmq-sqlalchemy Document](https://pgmq-sqlalchemy.readthedocs.io/en/latest/) for more examples and detailed usage. For `dispatcher.py`: @@ -115,7 +115,7 @@ print(metrics.total_messages) ## Issue/ Contributing / Development Welcome to open an issue or pull request !
-See [`Development` on Online Document](https://pgmq-sqlalchemy-python.readthedocs.io/en/latest/) or [CONTRIBUTING.md](.github/CONTRIBUTING.md) for more information. +See [`Development` on Online Document](https://pgmq-sqlalchemy.readthedocs.io/en/latest/) or [CONTRIBUTING.md](.github/CONTRIBUTING.md) for more information. ## TODO From 26b09c8110fd44906332776904f3bb0670b442e3 Mon Sep 17 00:00:00 2001 From: jason810496 <810496@email.wlsh.tyc.edu.tw> Date: Mon, 22 Jul 2024 01:06:54 +0800 Subject: [PATCH 2/4] fix: add missing extras dependencies --- pyproject.toml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index abb51b4..db966f4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -27,7 +27,7 @@ classifiers = [ "Documentation" = "https://pgmq-sqlalchemy.readthedocs.io/en/latest/" [tool.poetry.extras] -asyncpg = ["asyncpg"] +asyncpg = ["asyncpg", "greenlet"] pg8000 = ["pg8000"] psycopg = ["psycopg"] psycopg2-binary = ["psycopg2-binary"] @@ -37,6 +37,13 @@ psycopg2cffi = ["psycopg2cffi"] [tool.poetry.dependencies] python = "^3.9" SQLAlchemy = "^2.0.31" +# optional dependencies +asyncpg = {version = "^0.29.0", optional = true} +greenlet = {version = "^3.0.3", optional = true} +pg8000 = {version = "^1.31.2", optional = true} +psycopg = {version = "^3.2.1", optional = true} +psycopg2-binary = {version = "^2.9.9", optional = true} +psycopg2cffi = {version = "^2.9.0", optional = true} [tool.poetry.group.dev.dependencies] # postgresql drivers From 9bff8e60896ef7c6fa697a036208daf954d81ae5 Mon Sep 17 00:00:00 2001 From: jason810496 <810496@email.wlsh.tyc.edu.tw> Date: Mon, 22 Jul 2024 01:09:29 +0800 Subject: [PATCH 3/4] doc: update installation instructions for extras --- doc/installation.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/installation.rst b/doc/installation.rst index f695837..9660475 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -15,9 +15,9 @@ Install with additional DBAPIs packages .. code-block:: bash - pip install pgmq-sqlalchemy[psycopg2] - pip install pgmq-sqlalchemy[asyncpg] - # pip install pgmq-sqlalchemy[postgres-python-driver] + pip install "pgmq-sqlalchemy[asyncpg]" + pip install "pgmq-sqlalchemy[psycopg2-binary]" + # pip install "pgmq-sqlalchemy[postgres-python-driver]" .. Note:: See `SQLAlchemy Postgresql Dialects `_ for all available DBAPIs packages. From 177c7b755b7a5c55918a9c572d71328d0d2f4498 Mon Sep 17 00:00:00 2001 From: jason810496 <810496@email.wlsh.tyc.edu.tw> Date: Mon, 22 Jul 2024 01:15:12 +0800 Subject: [PATCH 4/4] hotfix: update poetry lock file --- poetry.lock | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/poetry.lock b/poetry.lock index 909ac57..ba5f995 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1568,13 +1568,13 @@ doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linke test = ["big-O", "importlib-resources", "jaraco.functools", "jaraco.itertools", "jaraco.test", "more-itertools", "pytest (>=6,!=8.1.*)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-ignore-flaky", "pytest-mypy", "pytest-ruff (>=0.2.1)"] [extras] -asyncpg = [] -pg8000 = [] -psycopg = [] -psycopg2-binary = [] -psycopg2cffi = [] +asyncpg = ["asyncpg", "greenlet"] +pg8000 = ["pg8000"] +psycopg = ["psycopg"] +psycopg2-binary = ["psycopg2-binary"] +psycopg2cffi = ["psycopg2cffi"] [metadata] lock-version = "2.0" python-versions = "^3.9" -content-hash = "39d3494916f07c63acdfc5a10d436ac0c4de2a706cc14e1ca096ac163c4e19ef" +content-hash = "8d8136531140493b0acf2b97120e92289639ac5543158a3e575cfc357f2cdb7a"