pgque-py 0.2.0rc1__tar.gz

pgque_py-0.2.0rc1/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Nikolay Samokhvalov
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pgque_py-0.2.0rc1/PKG-INFO

@@ -0,0 +1,246 @@
+Metadata-Version: 2.4
+Name: pgque-py
+Version: 0.2.0rc1
+Summary: Python client for PgQue -- PgQ Universal Edition
+Author-email: Nikolay Samokhvalov <nik@postgres.ai>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/NikolayS/pgque
+Project-URL: Repository, https://github.com/NikolayS/pgque
+Project-URL: Issues, https://github.com/NikolayS/pgque/issues
+Project-URL: Documentation, https://github.com/NikolayS/pgque/blob/main/docs/reference.md
+Keywords: postgres,postgresql,queue,pgq,pgque,background-jobs
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: psycopg[binary]<4,>=3.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# pgque-py
+
+Python client for [PgQue](https://github.com/NikolayS/pgque) — the PgQ-based
+universal PostgreSQL queue. Thin wrapper over `pgque-api` SQL functions:
+`send`, `receive`, `ack`, `nack`, `force_next_tick`, plus a polling
+`Consumer` with `LISTEN`/`NOTIFY` wakeup.
+
+## Install
+
+After the first Python client release:
+
+```bash
+pip install pgque-py
+```
+
+Requires Python 3.10+ and PostgreSQL 14+ with the PgQue schema installed
+(`\i pgque.sql` — no extension required).
+
+## Database permissions
+
+The connecting database role needs `pgque_reader` to consume (`receive`, `ack`, `nack`, `subscribe`, `unsubscribe`) and `pgque_writer` to produce (`send`, `send_batch`). The two are **siblings** — neither inherits the other. An app that both produces and consumes (the typical case for code using this client) must be granted **both** roles:
+
+```sql
+grant pgque_reader to your_app_user;
+grant pgque_writer to your_app_user;
+```
+
+See [`docs/reference.md` — Roles and grants](../../docs/reference.md#roles-and-grants) for the full role table.
+
+## Quickstart
+
+```python
+import pgque
+
+with pgque.connect("postgresql://localhost/mydb") as client:
+    # one-time setup (typically in a migration)
+    client.conn.execute("select pgque.subscribe('orders', 'order_worker')")
+    client.conn.commit()
+
+    # producer: commit once to publish both calls atomically
+    event_id = client.send("orders", {"order_id": 42}, type="order.created")
+    batch_ids = client.send_batch("orders", "order.created", [
+        {"order_id": 43},
+        {"order_id": 44},
+    ])
+    client.conn.commit()
+    print(event_id, batch_ids)
+
+# consumer (separate process / thread)
+consumer = pgque.Consumer(
+    dsn="postgresql://localhost/mydb",
+    queue="orders",
+    name="order_worker",
+)
+
+@consumer.on("order.created")
+def handle_order(msg: pgque.Message) -> None:
+    print(f"got {msg.type}: {msg.payload}")
+
+# Optional: catch-all handler for types with no specific handler.
+# Without it, messages with unhandled types are nacked by default
+# (sent to retry_queue, or to the dead-letter queue once
+# queue_max_retries is exhausted). Register a "*" handler to take
+# explicit control.
+@consumer.on("*")
+def handle_unknown(msg: pgque.Message) -> None:
+    print(f"unhandled type {msg.type!r}: {msg.payload}")
+
+consumer.start()  # blocks until SIGTERM / SIGINT
+```
+
+### Consumer options
+
+`Consumer(..., max_messages=...)` controls the per-`receive` limit.
+The default is PostgreSQL's `int` maximum, so the consumer requests
+the whole PgQ batch before acknowledging it. `ack()` finishes the
+entire underlying PgQ batch, including rows beyond `max_messages`;
+only lower this value when it is at least as large as the queue's
+worst-case batch size, otherwise rows past the limit are silently
+skipped by the batch ack.
+
+### Handling unknown event types
+
+By default the consumer **nacks** any message whose type has no
+registered handler and no `"*"` catch-all. The message is retried (or
+dead-lettered once `queue_max_retries` is exhausted) so unknown types
+are never silently dropped.
+
+To ack unknown types instead, pass `unknown_handler_policy="ack"`:
+
+```python
+consumer = pgque.Consumer(
+    dsn="postgresql://localhost/mydb",
+    queue="orders",
+    name="order_worker",
+    unknown_handler_policy="ack",  # log WARNING and ack; do not nack
+)
+```
+
+## Experimental: cooperative consumers
+
+> **Experimental in PgQue 0.2.** Function names, edge-case behavior, and
+> client API shape may change before this feature is marked stable. Do
+> not use this as the only processing path for critical workloads
+> without idempotent handlers and stale-worker takeover tests.
+
+Cooperative consumers let several worker processes share **one logical
+consumer**. Each batch is handed to exactly one subconsumer; the main
+row owns the group cursor, member rows own active batches. See
+[`docs/reference.md` — Cooperative consumers / subconsumers](../../docs/reference.md#cooperative-consumers--subconsumers)
+for the SQL surface.
+
+Two-worker example (each worker holds its own connection / process):
+
+```python
+import pgque
+
+# worker-1
+c1 = pgque.Consumer(
+    dsn="postgresql://localhost/mydb",
+    queue="orders",
+    name="order_worker",
+    subconsumer="worker-1",
+    dead_interval="5 minutes",  # optional: take over a stale sibling
+)
+
+@c1.on("order.created")
+def handle(msg):
+    process(msg)
+
+c1.start()  # in a second process: subconsumer="worker-2"
+```
+
+`Consumer(subconsumer=...)` switches the poll loop to
+`receive_coop` and auto-registers the `coop_main` + `coop_member` rows
+on the first call. `dead_interval` is only valid in cooperative mode;
+passing it without `subconsumer` raises `ValueError`.
+
+The low-level methods on `PgqueClient` are also available for direct
+use:
+
+```python
+client.subscribe_subconsumer("orders", "order_worker", "worker-1")
+msgs = client.receive_coop(
+    "orders", "order_worker", "worker-1",
+    max_messages=100, dead_interval="5 minutes",
+)
+client.ack(msgs[0].batch_id)
+client.touch_subconsumer("orders", "order_worker", "worker-1")
+client.unsubscribe_subconsumer(
+    "orders", "order_worker", "worker-1", batch_handling=1,
+)
+```
+
+`unsubscribe_subconsumer(..., batch_handling=0)` (the default) raises if
+the subconsumer holds an active batch; pass `batch_handling=1` to route
+active messages through retry/DLQ before removal.
+
+A runnable two-worker demo lives at
+[`bench/coop_demo.py`](bench/coop_demo.py); run it against any pgque
+database with `PGQUE_TEST_DSN` set.
+
+## Manual ticking
+
+For tests, demos, or manual operation without `pg_cron`, use
+`client.force_next_tick(queue)` to force the **next** `pgque.ticker()` call to
+materialize a tick. It does not insert the tick itself:
+
+```python
+client.force_next_tick("orders")
+client.conn.execute("select pgque.ticker()")
+client.conn.commit()
+```
+
+`client.force_tick(queue)` remains as a deprecated compatibility alias.
+
+## Transactions
+
+`send` → ticker → `receive` must each run in its own committed transaction (PgQue is snapshot-based). `pgque.connect(dsn)` is non-autocommit by default — commit between produce and consumer. The `Consumer` is autocommit + explicit `conn.transaction()` around `receive + dispatch + ack`.
+
+Don't wrap `send` and `receive` in one explicit tx; same for `maint_retry_events` + `ticker`. See [snapshot rule](https://github.com/NikolayS/pgque/blob/main/docs/pgq-concepts.md#snapshot-rule).
+
+
+## Tests
+
+Integration tests require a running PostgreSQL with the PgQue schema
+installed. Set `PGQUE_TEST_DSN` and run pytest:
+
+```bash
+PGQUE_TEST_DSN=postgresql://postgres:pgque_test@localhost/pgque_test \
+    pytest clients/python/tests
+```
+
+Without `PGQUE_TEST_DSN`, the tests skip.
+
+## Distribution
+
+The PyPI distribution is `pgque-py`; the import package is `pgque`:
+
+```python
+import pgque
+```
+
+See [RELEASE.md](RELEASE.md) for publishing steps.
+
+## More
+
+- Schema install, full reference, tutorial:
+  <https://github.com/NikolayS/pgque>
+- Per-function SQL reference:
+  <https://github.com/NikolayS/pgque/blob/main/docs/reference.md>
+- Issues: <https://github.com/NikolayS/pgque/issues>
+
+## License
+
+Apache-2.0. Copyright 2026 Nikolay Samokhvalov.

pgque_py-0.2.0rc1/README.md

@@ -0,0 +1,216 @@
+# pgque-py
+
+Python client for [PgQue](https://github.com/NikolayS/pgque) — the PgQ-based
+universal PostgreSQL queue. Thin wrapper over `pgque-api` SQL functions:
+`send`, `receive`, `ack`, `nack`, `force_next_tick`, plus a polling
+`Consumer` with `LISTEN`/`NOTIFY` wakeup.
+
+## Install
+
+After the first Python client release:
+
+```bash
+pip install pgque-py
+```
+
+Requires Python 3.10+ and PostgreSQL 14+ with the PgQue schema installed
+(`\i pgque.sql` — no extension required).
+
+## Database permissions
+
+The connecting database role needs `pgque_reader` to consume (`receive`, `ack`, `nack`, `subscribe`, `unsubscribe`) and `pgque_writer` to produce (`send`, `send_batch`). The two are **siblings** — neither inherits the other. An app that both produces and consumes (the typical case for code using this client) must be granted **both** roles:
+
+```sql
+grant pgque_reader to your_app_user;
+grant pgque_writer to your_app_user;
+```
+
+See [`docs/reference.md` — Roles and grants](../../docs/reference.md#roles-and-grants) for the full role table.
+
+## Quickstart
+
+```python
+import pgque
+
+with pgque.connect("postgresql://localhost/mydb") as client:
+    # one-time setup (typically in a migration)
+    client.conn.execute("select pgque.subscribe('orders', 'order_worker')")
+    client.conn.commit()
+
+    # producer: commit once to publish both calls atomically
+    event_id = client.send("orders", {"order_id": 42}, type="order.created")
+    batch_ids = client.send_batch("orders", "order.created", [
+        {"order_id": 43},
+        {"order_id": 44},
+    ])
+    client.conn.commit()
+    print(event_id, batch_ids)
+
+# consumer (separate process / thread)
+consumer = pgque.Consumer(
+    dsn="postgresql://localhost/mydb",
+    queue="orders",
+    name="order_worker",
+)
+
+@consumer.on("order.created")
+def handle_order(msg: pgque.Message) -> None:
+    print(f"got {msg.type}: {msg.payload}")
+
+# Optional: catch-all handler for types with no specific handler.
+# Without it, messages with unhandled types are nacked by default
+# (sent to retry_queue, or to the dead-letter queue once
+# queue_max_retries is exhausted). Register a "*" handler to take
+# explicit control.
+@consumer.on("*")
+def handle_unknown(msg: pgque.Message) -> None:
+    print(f"unhandled type {msg.type!r}: {msg.payload}")
+
+consumer.start()  # blocks until SIGTERM / SIGINT
+```
+
+### Consumer options
+
+`Consumer(..., max_messages=...)` controls the per-`receive` limit.
+The default is PostgreSQL's `int` maximum, so the consumer requests
+the whole PgQ batch before acknowledging it. `ack()` finishes the
+entire underlying PgQ batch, including rows beyond `max_messages`;
+only lower this value when it is at least as large as the queue's
+worst-case batch size, otherwise rows past the limit are silently
+skipped by the batch ack.
+
+### Handling unknown event types
+
+By default the consumer **nacks** any message whose type has no
+registered handler and no `"*"` catch-all. The message is retried (or
+dead-lettered once `queue_max_retries` is exhausted) so unknown types
+are never silently dropped.
+
+To ack unknown types instead, pass `unknown_handler_policy="ack"`:
+
+```python
+consumer = pgque.Consumer(
+    dsn="postgresql://localhost/mydb",
+    queue="orders",
+    name="order_worker",
+    unknown_handler_policy="ack",  # log WARNING and ack; do not nack
+)
+```
+
+## Experimental: cooperative consumers
+
+> **Experimental in PgQue 0.2.** Function names, edge-case behavior, and
+> client API shape may change before this feature is marked stable. Do
+> not use this as the only processing path for critical workloads
+> without idempotent handlers and stale-worker takeover tests.
+
+Cooperative consumers let several worker processes share **one logical
+consumer**. Each batch is handed to exactly one subconsumer; the main
+row owns the group cursor, member rows own active batches. See
+[`docs/reference.md` — Cooperative consumers / subconsumers](../../docs/reference.md#cooperative-consumers--subconsumers)
+for the SQL surface.
+
+Two-worker example (each worker holds its own connection / process):
+
+```python
+import pgque
+
+# worker-1
+c1 = pgque.Consumer(
+    dsn="postgresql://localhost/mydb",
+    queue="orders",
+    name="order_worker",
+    subconsumer="worker-1",
+    dead_interval="5 minutes",  # optional: take over a stale sibling
+)
+
+@c1.on("order.created")
+def handle(msg):
+    process(msg)
+
+c1.start()  # in a second process: subconsumer="worker-2"
+```
+
+`Consumer(subconsumer=...)` switches the poll loop to
+`receive_coop` and auto-registers the `coop_main` + `coop_member` rows
+on the first call. `dead_interval` is only valid in cooperative mode;
+passing it without `subconsumer` raises `ValueError`.
+
+The low-level methods on `PgqueClient` are also available for direct
+use:
+
+```python
+client.subscribe_subconsumer("orders", "order_worker", "worker-1")
+msgs = client.receive_coop(
+    "orders", "order_worker", "worker-1",
+    max_messages=100, dead_interval="5 minutes",
+)
+client.ack(msgs[0].batch_id)
+client.touch_subconsumer("orders", "order_worker", "worker-1")
+client.unsubscribe_subconsumer(
+    "orders", "order_worker", "worker-1", batch_handling=1,
+)
+```
+
+`unsubscribe_subconsumer(..., batch_handling=0)` (the default) raises if
+the subconsumer holds an active batch; pass `batch_handling=1` to route
+active messages through retry/DLQ before removal.
+
+A runnable two-worker demo lives at
+[`bench/coop_demo.py`](bench/coop_demo.py); run it against any pgque
+database with `PGQUE_TEST_DSN` set.
+
+## Manual ticking
+
+For tests, demos, or manual operation without `pg_cron`, use
+`client.force_next_tick(queue)` to force the **next** `pgque.ticker()` call to
+materialize a tick. It does not insert the tick itself:
+
+```python
+client.force_next_tick("orders")
+client.conn.execute("select pgque.ticker()")
+client.conn.commit()
+```
+
+`client.force_tick(queue)` remains as a deprecated compatibility alias.
+
+## Transactions
+
+`send` → ticker → `receive` must each run in its own committed transaction (PgQue is snapshot-based). `pgque.connect(dsn)` is non-autocommit by default — commit between produce and consumer. The `Consumer` is autocommit + explicit `conn.transaction()` around `receive + dispatch + ack`.
+
+Don't wrap `send` and `receive` in one explicit tx; same for `maint_retry_events` + `ticker`. See [snapshot rule](https://github.com/NikolayS/pgque/blob/main/docs/pgq-concepts.md#snapshot-rule).
+
+
+## Tests
+
+Integration tests require a running PostgreSQL with the PgQue schema
+installed. Set `PGQUE_TEST_DSN` and run pytest:
+
+```bash
+PGQUE_TEST_DSN=postgresql://postgres:pgque_test@localhost/pgque_test \
+    pytest clients/python/tests
+```
+
+Without `PGQUE_TEST_DSN`, the tests skip.
+
+## Distribution
+
+The PyPI distribution is `pgque-py`; the import package is `pgque`:
+
+```python
+import pgque
+```
+
+See [RELEASE.md](RELEASE.md) for publishing steps.
+
+## More
+
+- Schema install, full reference, tutorial:
+  <https://github.com/NikolayS/pgque>
+- Per-function SQL reference:
+  <https://github.com/NikolayS/pgque/blob/main/docs/reference.md>
+- Issues: <https://github.com/NikolayS/pgque/issues>
+
+## License
+
+Apache-2.0. Copyright 2026 Nikolay Samokhvalov.