Skip to content

Commit c4f94aa

Browse files
authored
Merge pull request #4 from jason810496/develop
Fix: README RTD links & `poetry` extras dependencies setting
2 parents c418363 + d7457a2 commit c4f94aa

File tree

4 files changed

+22
-15
lines changed

4 files changed

+22
-15
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ pip install pgmq-sqlalchemy
4242
Install with additional DBAPIs packages:
4343

4444
```bash
45-
pip install pgmq-sqlalchemy[psycopg2]
46-
pip install pgmq-sqlalchemy[asyncpg]
47-
# pip install pgmq-sqlalchemy[postgres-python-driver]
45+
pip install "pgmq-sqlalchemy[asyncpg]"
46+
pip install "pgmq-sqlalchemy[psycopg2-binary]"
47+
# pip install "pgmq-sqlalchemy[postgres-python-driver]"
4848
```
4949

5050
## Getting Started
@@ -61,7 +61,7 @@ docker run -d --name postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 quay.io
6161
### Usage
6262

6363
> [!NOTE]
64-
> Check [pgmq-sqlalchemy Document](https://pgmq-sqlalchemy-python.readthedocs.io/en/latest/) for more examples and detailed usage.
64+
> Check [pgmq-sqlalchemy Document](https://pgmq-sqlalchemy.readthedocs.io/en/latest/) for more examples and detailed usage.
6565
6666

6767
For `dispatcher.py`:
@@ -115,7 +115,7 @@ print(metrics.total_messages)
115115
## Issue/ Contributing / Development
116116

117117
Welcome to open an issue or pull request ! <br>
118-
See [`Development` on Online Document](https://pgmq-sqlalchemy-python.readthedocs.io/en/latest/) or [CONTRIBUTING.md](.github/CONTRIBUTING.md) for more information.
118+
See [`Development` on Online Document](https://pgmq-sqlalchemy.readthedocs.io/en/latest/) or [CONTRIBUTING.md](.github/CONTRIBUTING.md) for more information.
119119

120120
## TODO
121121

doc/installation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Install with additional DBAPIs packages
1515

1616
.. code-block:: bash
1717
18-
pip install pgmq-sqlalchemy[psycopg2]
19-
pip install pgmq-sqlalchemy[asyncpg]
20-
# pip install pgmq-sqlalchemy[postgres-python-driver]
18+
pip install "pgmq-sqlalchemy[asyncpg]"
19+
pip install "pgmq-sqlalchemy[psycopg2-binary]"
20+
# pip install "pgmq-sqlalchemy[postgres-python-driver]"
2121
2222
.. Note:: See `SQLAlchemy Postgresql Dialects <https://docs.sqlalchemy.org/en/20/dialects/postgresql.html>`_ for all available DBAPIs packages.
2323

poetry.lock

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ classifiers = [
2727
"Documentation" = "https://pgmq-sqlalchemy.readthedocs.io/en/latest/"
2828

2929
[tool.poetry.extras]
30-
asyncpg = ["asyncpg"]
30+
asyncpg = ["asyncpg", "greenlet"]
3131
pg8000 = ["pg8000"]
3232
psycopg = ["psycopg"]
3333
psycopg2-binary = ["psycopg2-binary"]
@@ -37,6 +37,13 @@ psycopg2cffi = ["psycopg2cffi"]
3737
[tool.poetry.dependencies]
3838
python = "^3.9"
3939
SQLAlchemy = "^2.0.31"
40+
# optional dependencies
41+
asyncpg = {version = "^0.29.0", optional = true}
42+
greenlet = {version = "^3.0.3", optional = true}
43+
pg8000 = {version = "^1.31.2", optional = true}
44+
psycopg = {version = "^3.2.1", optional = true}
45+
psycopg2-binary = {version = "^2.9.9", optional = true}
46+
psycopg2cffi = {version = "^2.9.0", optional = true}
4047

4148
[tool.poetry.group.dev.dependencies]
4249
# postgresql drivers

0 commit comments

Comments
 (0)