Skip to content

Commit

Permalink
Merge pull request #4 from jason810496/develop
Browse files Browse the repository at this point in the history
Fix: README RTD links & `poetry` extras dependencies setting
  • Loading branch information
jason810496 authored Jul 21, 2024
2 parents c418363 + d7457a2 commit c4f94aa
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 15 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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`:
Expand Down Expand Up @@ -115,7 +115,7 @@ print(metrics.total_messages)
## Issue/ Contributing / Development

Welcome to open an issue or pull request ! <br>
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

Expand Down
6 changes: 3 additions & 3 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.sqlalchemy.org/en/20/dialects/postgresql.html>`_ for all available DBAPIs packages.

12 changes: 6 additions & 6 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand All @@ -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
Expand Down

0 comments on commit c4f94aa

Please sign in to comment.