pytest-pglite 0.1.0__tar.gz

pytest_pglite-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

pytest_pglite-0.1.0/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.4
+Name: pytest-pglite
+Version: 0.1.0
+Summary: Native PGlite (PostgreSQL in WebAssembly) for Python test suites, with first-class pytest integration
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: pytest,postgres,postgresql,pglite,wasm,wasmtime,testing
+Author: Don Bowman
+Author-email: don@agilicus.com
+Requires-Python: >=3.14
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Provides-Extra: async
+Provides-Extra: django
+Provides-Extra: examples
+Provides-Extra: sqlalchemy
+Requires-Dist: alembic (>=1.16,<2) ; extra == "examples"
+Requires-Dist: asyncpg (>=0.31,<1) ; extra == "examples"
+Requires-Dist: django (>=6.1,<7) ; extra == "django"
+Requires-Dist: fastapi (>=0.142,<1) ; extra == "examples"
+Requires-Dist: httpx (>=0.28,<1) ; extra == "examples"
+Requires-Dist: platformdirs (>=4.3,<5)
+Requires-Dist: psycopg[binary] (>=3.3,<4) ; extra == "async"
+Requires-Dist: psycopg[binary] (>=3.3,<4) ; extra == "examples"
+Requires-Dist: pydantic (>=2.13,<3)
+Requires-Dist: pydantic-settings (>=2.15,<3)
+Requires-Dist: pytest (>=9.1,<10)
+Requires-Dist: pytest-asyncio (>=1.4,<2) ; extra == "examples"
+Requires-Dist: pytest-django (>=4.14,<5) ; extra == "django"
+Requires-Dist: sqlalchemy[asyncio] (>=2.1,<3) ; extra == "examples"
+Requires-Dist: sqlalchemy[asyncio] (>=2.1,<3) ; extra == "sqlalchemy"
+Requires-Dist: wasmtime (>=49.0,<50)
+Project-URL: Homepage, https://github.com/donbowman/pytest-pglite
+Project-URL: Issues, https://github.com/donbowman/pytest-pglite/issues
+Project-URL: Repository, https://github.com/donbowman/pytest-pglite
+Description-Content-Type: text/markdown
+
+# pytest-pglite
+
+Real PostgreSQL in your Python process, for tests. No Docker, no server, no
+Node.js. `pytest-pglite` embeds PGlite, the WebAssembly build of PostgreSQL
+17.5, through [Wasmtime](https://wasmtime.dev/) and exposes it as a Postgres
+wire-protocol server so every Python client just works.
+
+```python
+def test_users(pglite_engine):
+    with pglite_engine.begin() as conn:
+        conn.execute(text("create table users (id serial primary key, name text)"))
+        conn.execute(text("insert into users (name) values ('Alice')"))
+        assert conn.execute(text("select count(*) from users")).scalar_one() == 1
+```
+
+## Features
+
+- **Native WASM** - PostgreSQL runs inside the Python process via Wasmtime,
+  with only the standard WebAssembly System Interface as a dependency.
+- **Real wire protocol** - psycopg (sync and async), asyncpg, SQLAlchemy,
+  Django and anything else that speaks Postgres connect to a local Unix socket
+  or TCP port.
+- **pytest first** - session-scoped fast startup, function-scoped isolation,
+  first-class support for `pytest-xdist` (each worker gets its own database).
+- **Multiple connections** - connections share one single-user Postgres
+  backend through a queue with transaction pinning, mirroring upstream
+  PGlite behaviour.
+- **Async ready** - the server is asyncio based; async fixtures are provided
+  for FastAPI, httpx and other async test suites.
+- **pgvector** - `CREATE EXTENSION vector` works out of the box.
+- **Fast** - a warm worker starts in well under a second; per-test isolation
+  resets take milliseconds.
+
+## Install
+
+```bash
+pip install pytest-pglite
+# optional extras
+pip install "pytest-pglite[sqlalchemy]"
+pip install "pytest-pglite[async]"
+pip install "pytest-pglite[django]"
+pip install "pytest-pglite[examples]"
+```
+
+The pytest plugin is registered automatically through the `pytest11` entry
+point, so there is nothing to import or configure.
+
+## Fixtures
+
+| Fixture | Scope | Description |
+| --- | --- | --- |
+| `pglite_server` | session | Running `PGliteServer` instance (one per xdist worker) |
+| `pglite_dsn` | session | libpq connection string (Unix socket, or TCP) |
+| `pglite_url` | session | SQLAlchemy URL string |
+| `pglite_conn` | function | `psycopg.Connection` with a freshly reset schema |
+| `pglite_async_conn` | function | `psycopg.AsyncConnection` with a freshly reset schema |
+| `pglite_asyncpg` | function | `asyncpg.Connection` with a freshly reset schema |
+| `pglite_engine` | function | SQLAlchemy `Engine` with a freshly reset schema |
+| `pglite_execute` | function | Callable that runs SQL and returns rows |
+
+## Options
+
+```
+--pglite-extensions=vector        Comma separated extensions to create
+--pglite-isolation=schema         none | schema | transaction | database
+--pglite-tcp                      Also listen on TCP (127.0.0.1, ephemeral port)
+--pglite-tcp-address=host:port    Explicit TCP bind address (default port 0 = OS assigned)
+--pglite-work-dir=PATH            Directory for database files (default: temp dir)
+--pglite-wasm=PATH                Use a custom pglite.wasi build
+--pglite-keep-tmp                 Keep the temporary database directory
+--pglite-log-level=INFO           Engine log level
+```
+
+All options can also be set with environment variables using the `PGLITE_`
+prefix, for example `PGLITE_ISOLATION=transaction`.
+
+## Standalone server
+
+The same engine can run outside pytest, for example for a manual psql session
+or a development server:
+
+```bash
+pytest-pglite --tcp-address 127.0.0.1:0 --extensions vector
+# PGlite ready: postgresql://postgres:password@127.0.0.1:54321/template1?sslmode=disable
+```
+
+```python
+from pytest_pglite import PGliteConfig, PGliteServer
+
+with PGliteServer(PGliteConfig(tcp=True)) as server:
+    print(server.dsn)
+```
+
+## xdist
+
+Each `pytest-xdist` worker process starts its own PGlite instance with its own
+temporary directory, its own Unix socket (or its own OS-assigned TCP port).
+There are no shared paths and no port collisions, so `pytest -n 4` just works.
+
+## How it works
+
+The package embeds `pglite.wasi`, a WebAssembly build of PostgreSQL 17.5 with
+pgvector statically linked. It is built from
+[electric-sql/pglite-build](https://github.com/electric-sql/pglite-build) by
+the pipeline in `build/` (see `build/README.md` for the patches and
+provenance). A small engine wrapper drives the WASI module through Wasmtime.
+On top of the
+single-user backend, an asyncio Postgres wire-protocol proxy manages client
+connections: each connection is a logical session, and protocol exchanges are
+serialised through a query queue. Statements and portals are renamed per
+connection so prepared-statement clients (psycopg3, asyncpg, SQLAlchemy) can
+share one backend safely.
+
+PGlite is single user, exactly like embedded SQLite. Concurrent connections
+work, but work is serialised; a connection holding an open transaction holds
+the backend until it commits or rolls back.
+
+## Performance
+
+Measured on the development machine (Linux x86_64, CPython 3.14):
+
+| Measurement | Result |
+| --- | --- |
+| Cold start (first ever, compiles WASM + initdb) | about 2.5 s |
+| Warm start, new worker (AOT + template cache) | about 0.25 s |
+| New connection | about 1 ms |
+| Query round trip (`pytest-pglite` overhead) | about 1.3 ms |
+| Per-test schema reset | about 1 ms |
+
+Compiled-module files and an initialised database template are cached under
+the platform cache directory; `pytest-xdist` workers share them.
+
+## Limitations
+
+- Single database, single user (`postgres`). `CREATE DATABASE` and connected
+  database switching are not supported.
+- Single backend: work from concurrent connections is queued, and a connection
+  holding an open transaction blocks others until it commits or rolls back.
+  Waiting connections time out with SQLSTATE 57014 after `queue_timeout`
+  seconds (default 60).
+- Session state is shared: `SET search_path`, `SET timezone` and similar
+  run-time parameters affect every connection because they share one backend
+  session. Use `SET LOCAL` inside a transaction for per-test values.
+- PostgreSQL wire-protocol server features are limited to what test suites
+  need: `LISTEN/NOTIFY` delivery is not implemented, and cancellation requests
+  are accepted but not acted on.
+- `COPY TO STDOUT` works; `COPY FROM STDIN` is rejected with SQLSTATE 0A000
+  because libpglite's synchronous transport cannot stream `CopyData` during
+  `CopyFrom`.
+- SQL errors kill the WebAssembly instance (the upstream WASI build has no
+  `setjmp`/`longjmp`). The Python host forwards the real ErrorResponse and
+  SQLSTATE, then restarts the backend over the same data directory when the
+  session cannot be recovered.
+- Extensions are compiled into the WASM module at build time; only the
+  bundled set (`plpgsql`, `vector`) can be created.
+- No Windows support for Unix sockets; use `--pglite-tcp` on Windows.
+
+## Development
+
+```bash
+poetry install --all-extras
+poetry run pytest
+poetry run black .
+poetry run flake8
+poetry run mypy
+```
+
+The WASM artifact lives in `src/pytest_pglite/_wasm/`; see `build/README.md`
+for provenance and how to rebuild it. Rebuilding uses the upstream
+pglite-build pipeline; the orchestrator pins compiler parallelism through
+`PGLITE_JOBS` (default 8) because upstream defaults to `nproc` and can exhaust
+memory on large machines.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE) and
+[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
+

pytest_pglite-0.1.0/README.md

@@ -0,0 +1,177 @@
+# pytest-pglite
+
+Real PostgreSQL in your Python process, for tests. No Docker, no server, no
+Node.js. `pytest-pglite` embeds PGlite, the WebAssembly build of PostgreSQL
+17.5, through [Wasmtime](https://wasmtime.dev/) and exposes it as a Postgres
+wire-protocol server so every Python client just works.
+
+```python
+def test_users(pglite_engine):
+    with pglite_engine.begin() as conn:
+        conn.execute(text("create table users (id serial primary key, name text)"))
+        conn.execute(text("insert into users (name) values ('Alice')"))
+        assert conn.execute(text("select count(*) from users")).scalar_one() == 1
+```
+
+## Features
+
+- **Native WASM** - PostgreSQL runs inside the Python process via Wasmtime,
+  with only the standard WebAssembly System Interface as a dependency.
+- **Real wire protocol** - psycopg (sync and async), asyncpg, SQLAlchemy,
+  Django and anything else that speaks Postgres connect to a local Unix socket
+  or TCP port.
+- **pytest first** - session-scoped fast startup, function-scoped isolation,
+  first-class support for `pytest-xdist` (each worker gets its own database).
+- **Multiple connections** - connections share one single-user Postgres
+  backend through a queue with transaction pinning, mirroring upstream
+  PGlite behaviour.
+- **Async ready** - the server is asyncio based; async fixtures are provided
+  for FastAPI, httpx and other async test suites.
+- **pgvector** - `CREATE EXTENSION vector` works out of the box.
+- **Fast** - a warm worker starts in well under a second; per-test isolation
+  resets take milliseconds.
+
+## Install
+
+```bash
+pip install pytest-pglite
+# optional extras
+pip install "pytest-pglite[sqlalchemy]"
+pip install "pytest-pglite[async]"
+pip install "pytest-pglite[django]"
+pip install "pytest-pglite[examples]"
+```
+
+The pytest plugin is registered automatically through the `pytest11` entry
+point, so there is nothing to import or configure.
+
+## Fixtures
+
+| Fixture | Scope | Description |
+| --- | --- | --- |
+| `pglite_server` | session | Running `PGliteServer` instance (one per xdist worker) |
+| `pglite_dsn` | session | libpq connection string (Unix socket, or TCP) |
+| `pglite_url` | session | SQLAlchemy URL string |
+| `pglite_conn` | function | `psycopg.Connection` with a freshly reset schema |
+| `pglite_async_conn` | function | `psycopg.AsyncConnection` with a freshly reset schema |
+| `pglite_asyncpg` | function | `asyncpg.Connection` with a freshly reset schema |
+| `pglite_engine` | function | SQLAlchemy `Engine` with a freshly reset schema |
+| `pglite_execute` | function | Callable that runs SQL and returns rows |
+
+## Options
+
+```
+--pglite-extensions=vector        Comma separated extensions to create
+--pglite-isolation=schema         none | schema | transaction | database
+--pglite-tcp                      Also listen on TCP (127.0.0.1, ephemeral port)
+--pglite-tcp-address=host:port    Explicit TCP bind address (default port 0 = OS assigned)
+--pglite-work-dir=PATH            Directory for database files (default: temp dir)
+--pglite-wasm=PATH                Use a custom pglite.wasi build
+--pglite-keep-tmp                 Keep the temporary database directory
+--pglite-log-level=INFO           Engine log level
+```
+
+All options can also be set with environment variables using the `PGLITE_`
+prefix, for example `PGLITE_ISOLATION=transaction`.
+
+## Standalone server
+
+The same engine can run outside pytest, for example for a manual psql session
+or a development server:
+
+```bash
+pytest-pglite --tcp-address 127.0.0.1:0 --extensions vector
+# PGlite ready: postgresql://postgres:password@127.0.0.1:54321/template1?sslmode=disable
+```
+
+```python
+from pytest_pglite import PGliteConfig, PGliteServer
+
+with PGliteServer(PGliteConfig(tcp=True)) as server:
+    print(server.dsn)
+```
+
+## xdist
+
+Each `pytest-xdist` worker process starts its own PGlite instance with its own
+temporary directory, its own Unix socket (or its own OS-assigned TCP port).
+There are no shared paths and no port collisions, so `pytest -n 4` just works.
+
+## How it works
+
+The package embeds `pglite.wasi`, a WebAssembly build of PostgreSQL 17.5 with
+pgvector statically linked. It is built from
+[electric-sql/pglite-build](https://github.com/electric-sql/pglite-build) by
+the pipeline in `build/` (see `build/README.md` for the patches and
+provenance). A small engine wrapper drives the WASI module through Wasmtime.
+On top of the
+single-user backend, an asyncio Postgres wire-protocol proxy manages client
+connections: each connection is a logical session, and protocol exchanges are
+serialised through a query queue. Statements and portals are renamed per
+connection so prepared-statement clients (psycopg3, asyncpg, SQLAlchemy) can
+share one backend safely.
+
+PGlite is single user, exactly like embedded SQLite. Concurrent connections
+work, but work is serialised; a connection holding an open transaction holds
+the backend until it commits or rolls back.
+
+## Performance
+
+Measured on the development machine (Linux x86_64, CPython 3.14):
+
+| Measurement | Result |
+| --- | --- |
+| Cold start (first ever, compiles WASM + initdb) | about 2.5 s |
+| Warm start, new worker (AOT + template cache) | about 0.25 s |
+| New connection | about 1 ms |
+| Query round trip (`pytest-pglite` overhead) | about 1.3 ms |
+| Per-test schema reset | about 1 ms |
+
+Compiled-module files and an initialised database template are cached under
+the platform cache directory; `pytest-xdist` workers share them.
+
+## Limitations
+
+- Single database, single user (`postgres`). `CREATE DATABASE` and connected
+  database switching are not supported.
+- Single backend: work from concurrent connections is queued, and a connection
+  holding an open transaction blocks others until it commits or rolls back.
+  Waiting connections time out with SQLSTATE 57014 after `queue_timeout`
+  seconds (default 60).
+- Session state is shared: `SET search_path`, `SET timezone` and similar
+  run-time parameters affect every connection because they share one backend
+  session. Use `SET LOCAL` inside a transaction for per-test values.
+- PostgreSQL wire-protocol server features are limited to what test suites
+  need: `LISTEN/NOTIFY` delivery is not implemented, and cancellation requests
+  are accepted but not acted on.
+- `COPY TO STDOUT` works; `COPY FROM STDIN` is rejected with SQLSTATE 0A000
+  because libpglite's synchronous transport cannot stream `CopyData` during
+  `CopyFrom`.
+- SQL errors kill the WebAssembly instance (the upstream WASI build has no
+  `setjmp`/`longjmp`). The Python host forwards the real ErrorResponse and
+  SQLSTATE, then restarts the backend over the same data directory when the
+  session cannot be recovered.
+- Extensions are compiled into the WASM module at build time; only the
+  bundled set (`plpgsql`, `vector`) can be created.
+- No Windows support for Unix sockets; use `--pglite-tcp` on Windows.
+
+## Development
+
+```bash
+poetry install --all-extras
+poetry run pytest
+poetry run black .
+poetry run flake8
+poetry run mypy
+```
+
+The WASM artifact lives in `src/pytest_pglite/_wasm/`; see `build/README.md`
+for provenance and how to rebuild it. Rebuilding uses the upstream
+pglite-build pipeline; the orchestrator pins compiler parallelism through
+`PGLITE_JOBS` (default 8) because upstream defaults to `nproc` and can exhaust
+memory on large machines.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE) and
+[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).