clibmdbx 1.0.1__tar.gz

clibmdbx-1.0.1/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+This project follows Semantic Versioning and PEP 440. Released versions are
+immutable.
+
+## 1.0.1 - 2026-08-29
+
+- Initial stable public release of the hand-written CPython C-API binding.
+- Start the public version sequence at 1.0.1 by maintainer choice; 1.0.0 and
+  all earlier development versions were never published to a package index.
+- Embed the official libmdbx 0.14.3 amalgamation.
+- Add environment, transaction, DBI and cursor APIs, Python exception mapping,
+  C-loop batch primitives, thread affinity and post-fork rejection.
+- Add randomized model testing, concurrency, crash recovery, sanitizers,
+  `mdbx_chk`, reproducible benchmarks and multi-platform wheel CI.
+- Keep repeated database wrappers on one environment-owned native DBI; prevent
+  double-close, invalidate aliases after deleting drop, and invalidate handles
+  created by an aborted outer or nested transaction.
+- Guard GIL-detached environment operations against concurrent close and defer
+  accidental cross-thread write finalization to the native owner thread.
+- Expand native error subclasses and expose `code`, `what`, and `reason`.
+- Add an independently written parity suite for all 23 collected
+  wtdcode/mdbx-py test scenarios and pinned two-way on-disk interoperability
+  tests against `libmdbx==0.3.2`.
+- Expose official system RAM/page diagnostics and raise `OverflowError` for a
+  DB sequence increment that would exceed unsigned 64-bit storage.
+- Reject unsafe scalar use of native `MDBX_RESERVE` and `MDBX_MULTIPLE`, whose
+  pointer/array contracts cannot be represented by the scalar Python methods.
+- Harden cursor/transaction lifetime tracking around GIL-detached native calls,
+  including writer-owner configuration, nested transactions, cursor renewal,
+  cross-thread finalization and copied detached-batch results.
+- Reject free-threaded CPython builds until the lifecycle model has been
+  redesigned and validated without the GIL.
+- Add release-configuration gates for repository/security contacts and test the
+  exact sdist from the release workflow before any upload.

clibmdbx-1.0.1/CONTRIBUTING.md

@@ -0,0 +1,20 @@
+# Contributing
+
+Changes must preserve the central property of this package: the hot path is
+hand-written CPython C API code calling the vendored official libmdbx C API.
+ctypes, CFFI, Cython, Rust/PyO3 and runtime loading of another libmdbx are not
+accepted.
+
+Before submitting a change:
+
+1. Add focused success, boundary, failure and lifetime tests.
+2. Run `python -m pytest -q` with strict compiler warnings.
+3. Run the ASan/UBSan command in `docs/BUILDING.md` for C changes.
+4. Run `mdbx_chk` against any database written by a new storage operation.
+5. Update `docs/API_COVERAGE.md` and the public type stub for API changes.
+6. Run the benchmark three times for hot-path changes and commit raw JSON only
+   when the workload and machine metadata are complete.
+
+Do not commit databases, credentials, organization data, generated wheels, or
+private benchmark inputs. All commits must preserve the Apache-2.0 headers and
+third-party notices.

clibmdbx-1.0.1/LICENSE

@@ -0,0 +1,177 @@
+
+                                 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

clibmdbx-1.0.1/MANIFEST.in

@@ -0,0 +1,11 @@
+include LICENSE NOTICE README.md CHANGELOG.md SECURITY.md CONTRIBUTING.md
+include THIRD_PARTY_NOTICES.md SBOM.cdx.json VENDORING.md RELEASING.md
+recursive-include src *.c *.py *.pyi py.typed
+recursive-include vendor/libmdbx mdbx.c mdbx.h mdbx-internals.h mdbx_chk.c mdbx-wingetopt.h LICENSE NOTICE COPYRIGHT VERSION.json
+recursive-include docs *.md
+recursive-include tests *.py *.supp *.txt
+recursive-include benchmarks *.py *.md *.json
+recursive-include scripts *.py *.sh
+exclude .coverage
+prune build
+prune dist

clibmdbx-1.0.1/NOTICE

@@ -0,0 +1,9 @@
+clibmdbx
+Copyright 2026 clibmdbx contributors
+
+This product includes libmdbx v0.14.3, Copyright 2015-2026 Leonid Yuriev
+and contributors, and work derived from LMDB. See vendor/libmdbx/NOTICE and
+vendor/libmdbx/COPYRIGHT for complete attribution.
+
+clibmdbx is an independent community binding and is not an official libmdbx
+project.

clibmdbx-1.0.1/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: clibmdbx
+Version: 1.0.1
+Summary: High-performance CPython C-API bindings for an embedded libmdbx
+Author: clibmdbx contributors
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/jyj117/mdbx-py
+Project-URL: Issues, https://github.com/jyj117/mdbx-py/issues
+Project-URL: Changelog, https://github.com/jyj117/mdbx-py/blob/main/CHANGELOG.md
+Project-URL: Upstream, https://github.com/Mithril-mine/libmdbx
+Keywords: mdbx,libmdbx,database,key-value,cpython,extension
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Microsoft :: Windows :: Windows 10
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: C
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database :: Database Engines/Servers
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+License-File: vendor/libmdbx/LICENSE
+License-File: vendor/libmdbx/NOTICE
+License-File: vendor/libmdbx/COPYRIGHT
+Requires-Dist: typing_extensions>=4.15; python_version < "3.15"
+Dynamic: license-file
+
+# clibmdbx
+
+`clibmdbx` is an independent, high-performance CPython binding for
+[libmdbx](https://github.com/Mithril-mine/libmdbx). Both the distribution and
+import name are `clibmdbx`. It is a community project and is not an official
+Mithril-mine/libmdbx package.
+
+The hot path is hand-written CPython C API code calling the libmdbx C API
+directly. The extension embeds the official libmdbx 0.14.3 amalgamation, so a
+wheel does not load a system `libmdbx` and has no runtime Python dependencies.
+It does not use ctypes, CFFI, Cython, Rust, or a helper service.
+
+> **Stable release:** 1.0.1 deliberately uses a CPython-version-specific ABI
+> for maximum hot-path performance. Public API compatibility follows Semantic
+> Versioning within the 1.x line.
+
+## Quick start
+
+```python
+import clibmdbx
+
+with clibmdbx.Environment("cache.mdbx", max_dbs=8) as env:
+    with env.write() as txn:
+        txn.put(b"answer", b"42")
+
+    with env.read() as txn:
+        assert txn.get(b"answer") == b"42"
+        assert txn[b"answer"] == b"42"
+```
+
+Named databases, DUPSORT, cursors and batches use the same transaction model:
+
+```python
+with env.write() as txn:
+    events = txn.open_db(b"events", flags=clibmdbx.MDBX_DUPSORT, create=True)
+    txn.put_many([(b"job", b"started"), (b"job", b"finished")], db=events)
+
+with env.read() as txn, txn.cursor(events) as cursor:
+    print(cursor.set(b"job"))
+    print(cursor.count())
+```
+
+All keys and values accept `bytes` or a contiguous bytes-like object. Returned
+data is copied to safe `bytes`. `MDBX_RESERVE` and borrowed zero-copy views are
+not exposed because their native pointers can outlive neither the write call nor
+the mapped transaction safely.
+
+## Concurrency and lifetime rules
+
+- An `Environment` may be shared by threads. libmdbx still permits only one
+  write transaction at a time per environment.
+- A `Transaction` and every cursor belonging to it are bound to the thread that
+  created the transaction. Cross-thread use raises `ThreadError` before calling
+  libmdbx.
+- Transactions keep their environment alive; cursors and DB handles keep their
+  owners alive. Closing an environment with active transactions is rejected.
+  A `Database.close()` closes only that Python view because repeated opens may
+  share one native DBI; ordinary native DBIs remain environment-owned, avoiding
+  upstream's double-close/concurrent-close corruption hazard. Repeated
+  `close()`/`abort()` is safe.
+- A process created with `fork()` must open a fresh environment. Inherited
+  objects raise `ForkError`; their destructors intentionally do not call into
+  the parent's native handles.
+- The current single-phase high-performance extension supports CPython's main
+  interpreter only. Import in a subinterpreter raises `ImportError` explicitly
+  rather than sharing interpreter-owned exception/type objects unsafely. Use a
+  separate process when interpreter isolation is required.
+- `commit`, `sync`, `copy`, defragmentation and warm-up release the GIL once
+  around the native operation. A commit with an open cursor retains the GIL
+  because libmdbx updates the transaction's cursor list while committing; close
+  cursors first when concurrent Python progress during commit matters. Warm
+  point reads keep the GIL to avoid a costly
+  release/reacquire on every key. Batch methods cross Python/C once and loop in
+  C. Their default fast path retains the GIL; `detached=True` first copies every
+  input, then releases the GIL exactly once around the native loop. Use detached
+  mode for cold pages, large batches or latency-sensitive RPC thread pools.
+  Detached mode requires all cursors in the transaction and parent chain to be
+  closed, preventing cross-thread cursor finalization from racing native work.
+- The wrapper always enables native `MDBX_NOSTICKYTHREADS`, then applies the
+  stricter Python owner-thread checks itself. Read transactions can therefore
+  be finalized safely by a different Python worker. libmdbx still requires a
+  write transaction to finish on its creator OS thread: an accidental
+  cross-thread final reference is marked broken and queued, never unlocked on
+  the wrong thread. Its owner reaps it automatically on the next environment
+  operation or explicitly with `env.reap_orphaned_transactions()`.
+- `drop(delete=True)` is rejected while an unrelated transaction may still
+  reference the shared DBI. It invalidates all duplicate Python aliases after
+  the native delete-and-close succeeds. Creation rolled back at any nesting
+  level likewise invalidates its provisional aliases.
+
+Durability defaults are upstream libmdbx defaults. Unsafe modes such as
+`SAFE_NOSYNC`, `UTTERLY_NOSYNC`, `WRITEMAP`, and `NOMEMINIT` are opt-in constants;
+the binding never enables them silently.
+
+## Major APIs
+
+- `Environment`: geometry, options, flags, sync, consistent copy, online
+  defragmentation, warm-up, reader cleanup, statistics and information.
+- `Transaction`: read/write/nested transactions, commit timing, abort,
+  reset/renew, refresh, park/unpark, canary, GC information, DB enumeration,
+  CRUD, replace and batch operations.
+- `Database`: flags/statistics, sequence, clear/drop, close and rename.
+- `Cursor`: exact/range positioning, forward/reverse and DUPSORT traversal,
+  count, write/delete/renew, iterator protocol and bounded range collection.
+- Stable exception classes for common libmdbx failures, plus `ThreadError`,
+  `ForkError`, and `ClosedError` for wrapper safety checks. Native exceptions
+  include `code`, `what`, and `reason`, matching the diagnostic ergonomics
+  expected from mature LMDB bindings.
+
+See [the complete C API coverage matrix](docs/API_COVERAGE.md),
+[the API/lifecycle guide](docs/API.md),
+[the wtdcode/mdbx-py ctypes compatibility audit](docs/WTD_MDBX_PY_COMPATIBILITY.md),
+[the python-lmdb comparison](docs/LMDB_COMPATIBILITY.md), and
+[the benchmark method](benchmarks/README.md).
+
+## Build and verify from source
+
+A C11 compiler and CPython development headers are required. Builds use the
+vendored source and perform no network access.
+
+```bash
+python -m venv .venv
+. .venv/bin/activate
+python -m pip install -U pip build pytest twine
+python -m pip install -e .
+python -m pytest -q
+python -m build
+python -m twine check dist/*
+```
+
+Strict warnings are enabled by default. Sanitizer builds are supported on
+Clang/GCC:
+
+```bash
+CLIBMDBX_SANITIZE=address,undefined python -m pip install -e . --no-build-isolation
+ASAN_OPTIONS=detect_leaks=0:abort_on_error=1 \
+UBSAN_OPTIONS=halt_on_error=1 PYTHONMALLOC=malloc python -m pytest -q
+```
+
+For source provenance, wheel policy, release commands, and supported-platform
+evidence, see [VENDORING.md](VENDORING.md), [docs/BUILDING.md](docs/BUILDING.md),
+and [RELEASING.md](RELEASING.md).
+
+## Embedded source and license
+
+This source tree pins official libmdbx **0.14.3**, upstream release tag
+`v0.14.3`. The release tag resolves to commit
+`f7a3a9323cacacfa9dc6137ae7a7252a67744ff0`; the official amalgamation records
+source commit `251562b2dc55266d8e6d0e6627ec88ecb410702f`.
+The official amalgamation archive SHA-256 is
+`dbc4a791c44d3e51a8159eedfee0dedada7b21d46c22588f0fa99294983f33cd`.
+
+The wrapper and libmdbx are Apache-2.0 licensed. The sdist and wheels retain the
+wrapper and upstream `LICENSE`, `NOTICE`, and `COPYRIGHT`; see
+[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) and [SBOM.cdx.json](SBOM.cdx.json).

clibmdbx-1.0.1/README.md

@@ -0,0 +1,155 @@
+# clibmdbx
+
+`clibmdbx` is an independent, high-performance CPython binding for
+[libmdbx](https://github.com/Mithril-mine/libmdbx). Both the distribution and
+import name are `clibmdbx`. It is a community project and is not an official
+Mithril-mine/libmdbx package.
+
+The hot path is hand-written CPython C API code calling the libmdbx C API
+directly. The extension embeds the official libmdbx 0.14.3 amalgamation, so a
+wheel does not load a system `libmdbx` and has no runtime Python dependencies.
+It does not use ctypes, CFFI, Cython, Rust, or a helper service.
+
+> **Stable release:** 1.0.1 deliberately uses a CPython-version-specific ABI
+> for maximum hot-path performance. Public API compatibility follows Semantic
+> Versioning within the 1.x line.
+
+## Quick start
+
+```python
+import clibmdbx
+
+with clibmdbx.Environment("cache.mdbx", max_dbs=8) as env:
+    with env.write() as txn:
+        txn.put(b"answer", b"42")
+
+    with env.read() as txn:
+        assert txn.get(b"answer") == b"42"
+        assert txn[b"answer"] == b"42"
+```
+
+Named databases, DUPSORT, cursors and batches use the same transaction model:
+
+```python
+with env.write() as txn:
+    events = txn.open_db(b"events", flags=clibmdbx.MDBX_DUPSORT, create=True)
+    txn.put_many([(b"job", b"started"), (b"job", b"finished")], db=events)
+
+with env.read() as txn, txn.cursor(events) as cursor:
+    print(cursor.set(b"job"))
+    print(cursor.count())
+```
+
+All keys and values accept `bytes` or a contiguous bytes-like object. Returned
+data is copied to safe `bytes`. `MDBX_RESERVE` and borrowed zero-copy views are
+not exposed because their native pointers can outlive neither the write call nor
+the mapped transaction safely.
+
+## Concurrency and lifetime rules
+
+- An `Environment` may be shared by threads. libmdbx still permits only one
+  write transaction at a time per environment.
+- A `Transaction` and every cursor belonging to it are bound to the thread that
+  created the transaction. Cross-thread use raises `ThreadError` before calling
+  libmdbx.
+- Transactions keep their environment alive; cursors and DB handles keep their
+  owners alive. Closing an environment with active transactions is rejected.
+  A `Database.close()` closes only that Python view because repeated opens may
+  share one native DBI; ordinary native DBIs remain environment-owned, avoiding
+  upstream's double-close/concurrent-close corruption hazard. Repeated
+  `close()`/`abort()` is safe.
+- A process created with `fork()` must open a fresh environment. Inherited
+  objects raise `ForkError`; their destructors intentionally do not call into
+  the parent's native handles.
+- The current single-phase high-performance extension supports CPython's main
+  interpreter only. Import in a subinterpreter raises `ImportError` explicitly
+  rather than sharing interpreter-owned exception/type objects unsafely. Use a
+  separate process when interpreter isolation is required.
+- `commit`, `sync`, `copy`, defragmentation and warm-up release the GIL once
+  around the native operation. A commit with an open cursor retains the GIL
+  because libmdbx updates the transaction's cursor list while committing; close
+  cursors first when concurrent Python progress during commit matters. Warm
+  point reads keep the GIL to avoid a costly
+  release/reacquire on every key. Batch methods cross Python/C once and loop in
+  C. Their default fast path retains the GIL; `detached=True` first copies every
+  input, then releases the GIL exactly once around the native loop. Use detached
+  mode for cold pages, large batches or latency-sensitive RPC thread pools.
+  Detached mode requires all cursors in the transaction and parent chain to be
+  closed, preventing cross-thread cursor finalization from racing native work.
+- The wrapper always enables native `MDBX_NOSTICKYTHREADS`, then applies the
+  stricter Python owner-thread checks itself. Read transactions can therefore
+  be finalized safely by a different Python worker. libmdbx still requires a
+  write transaction to finish on its creator OS thread: an accidental
+  cross-thread final reference is marked broken and queued, never unlocked on
+  the wrong thread. Its owner reaps it automatically on the next environment
+  operation or explicitly with `env.reap_orphaned_transactions()`.
+- `drop(delete=True)` is rejected while an unrelated transaction may still
+  reference the shared DBI. It invalidates all duplicate Python aliases after
+  the native delete-and-close succeeds. Creation rolled back at any nesting
+  level likewise invalidates its provisional aliases.
+
+Durability defaults are upstream libmdbx defaults. Unsafe modes such as
+`SAFE_NOSYNC`, `UTTERLY_NOSYNC`, `WRITEMAP`, and `NOMEMINIT` are opt-in constants;
+the binding never enables them silently.
+
+## Major APIs
+
+- `Environment`: geometry, options, flags, sync, consistent copy, online
+  defragmentation, warm-up, reader cleanup, statistics and information.
+- `Transaction`: read/write/nested transactions, commit timing, abort,
+  reset/renew, refresh, park/unpark, canary, GC information, DB enumeration,
+  CRUD, replace and batch operations.
+- `Database`: flags/statistics, sequence, clear/drop, close and rename.
+- `Cursor`: exact/range positioning, forward/reverse and DUPSORT traversal,
+  count, write/delete/renew, iterator protocol and bounded range collection.
+- Stable exception classes for common libmdbx failures, plus `ThreadError`,
+  `ForkError`, and `ClosedError` for wrapper safety checks. Native exceptions
+  include `code`, `what`, and `reason`, matching the diagnostic ergonomics
+  expected from mature LMDB bindings.
+
+See [the complete C API coverage matrix](docs/API_COVERAGE.md),
+[the API/lifecycle guide](docs/API.md),
+[the wtdcode/mdbx-py ctypes compatibility audit](docs/WTD_MDBX_PY_COMPATIBILITY.md),
+[the python-lmdb comparison](docs/LMDB_COMPATIBILITY.md), and
+[the benchmark method](benchmarks/README.md).
+
+## Build and verify from source
+
+A C11 compiler and CPython development headers are required. Builds use the
+vendored source and perform no network access.
+
+```bash
+python -m venv .venv
+. .venv/bin/activate
+python -m pip install -U pip build pytest twine
+python -m pip install -e .
+python -m pytest -q
+python -m build
+python -m twine check dist/*
+```
+
+Strict warnings are enabled by default. Sanitizer builds are supported on
+Clang/GCC:
+
+```bash
+CLIBMDBX_SANITIZE=address,undefined python -m pip install -e . --no-build-isolation
+ASAN_OPTIONS=detect_leaks=0:abort_on_error=1 \
+UBSAN_OPTIONS=halt_on_error=1 PYTHONMALLOC=malloc python -m pytest -q
+```
+
+For source provenance, wheel policy, release commands, and supported-platform
+evidence, see [VENDORING.md](VENDORING.md), [docs/BUILDING.md](docs/BUILDING.md),
+and [RELEASING.md](RELEASING.md).
+
+## Embedded source and license
+
+This source tree pins official libmdbx **0.14.3**, upstream release tag
+`v0.14.3`. The release tag resolves to commit
+`f7a3a9323cacacfa9dc6137ae7a7252a67744ff0`; the official amalgamation records
+source commit `251562b2dc55266d8e6d0e6627ec88ecb410702f`.
+The official amalgamation archive SHA-256 is
+`dbc4a791c44d3e51a8159eedfee0dedada7b21d46c22588f0fa99294983f33cd`.
+
+The wrapper and libmdbx are Apache-2.0 licensed. The sdist and wheels retain the
+wrapper and upstream `LICENSE`, `NOTICE`, and `COPYRIGHT`; see
+[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) and [SBOM.cdx.json](SBOM.cdx.json).