ntcompress 0.1.0__tar.gz

ntcompress-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.

ntcompress-0.1.0/NOTICE

@@ -0,0 +1,14 @@
+ntcompress
+Copyright 2026 ntcompress contributors
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+these files except in compliance with the License. You may obtain a copy of the
+License in the LICENSE file or at http://www.apache.org/licenses/LICENSE-2.0.
+
+This product contains software derived from the Microsoft Extensible Storage
+Engine (https://github.com/microsoft/Extensible-Storage-Engine), licensed under
+the MIT License, Copyright (c) Microsoft Corporation. The XPRESS9 decoder and the
+CRC-32C / CRC-64 routines are ports of that MIT-licensed source. It also contains
+codecs derived from the published Microsoft Open Specification [MS-XCA] and an
+implementation of the LZ4 block format (Yann Collet). See THIRD-PARTY-NOTICES.md
+for the full attributions and license texts.

ntcompress-0.1.0/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: ntcompress
+Version: 0.1.0
+Summary: Pure-Python implementations of every Microsoft ESE record-compression scheme and Windows ntdll RtlCompressBuffer/RtlDecompressBuffer format.
+Keywords: ese,esent,jet,ntdll,xpress,xpress9,xpress10,lznt1,lz4,ms-xca,compression,forensics
+Author: ntcompress contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+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: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Security
+Classifier: Topic :: System :: Archiving :: Compression
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Project-URL: Repository, https://github.com/StrongWind1/ntcompress
+Project-URL: Documentation, https://strongwind1.github.io/ntcompress/
+Project-URL: Changelog, https://github.com/StrongWind1/ntcompress/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/StrongWind1/ntcompress/issues
+Description-Content-Type: text/markdown
+
+# ntcompress
+
+Pure-Python, standard-library-only implementations of every compression format used by Microsoft's Extensible Storage Engine (ESE/ESENT, the "JET Blue" engine behind `NTDS.dit`, Exchange stores, `Windows.edb`, `SRUDB.dat`, and `WebCacheV01.dat`) and Windows `ntdll.dll` compression (`RtlCompressBuffer` / `RtlDecompressBuffer`). No runtime dependencies beyond the standard library.
+
+## Scope
+
+This library covers two distinct compression layers used by Windows:
+
+### ESE record compression (vs `esent.dll`)
+
+ESE stores a one-byte header on each compressed record cell; the top 5 bits select the scheme (`first_byte >> 3`) and the low 3 bits carry scheme-specific flags.
+
+| ESE ID | Format | Decompress | Compress | Byte-Identical to esent.dll | Authority |
+|--------|--------|-----------|----------|---------------------------|-----------|
+| `0x0` | NONE (uncompressed sentinel) | — | — | — | `compression.cxx:504` |
+| `0x1` | 7-bit ASCII | yes | yes | yes | ESE source |
+| `0x2` | 7-bit Unicode | yes | yes | yes | ESE source |
+| `0x3` | XPRESS (Plain LZ77) | yes | yes | yes | `[MS-XCA] §2.3/2.4` |
+| `0x4` | SCRUB (erase marker) | produce | recognize | n/a | ESE source |
+| `0x5` | XPRESS9 | yes | yes | yes* | ESE MIT source (ported) |
+| `0x6` | XPRESS10 (LZ4 + CRC) | yes | yes | yes** | ESE source |
+| `0x7` | LZ4 (standard block) | yes | yes | yes | LZ4 block format |
+
+\*XPRESS9 encoder matches the MIT ESE C reference byte-for-byte excluding the non-deterministic session signature (`CRC32(__rdtsc())`), which even `esent.dll` varies on every call. \*\*XPRESS10 verified byte-identical by component construction (LZ4 block + CRC-32C + CRC-64/NVME each individually proven); not triggerable on commodity hardware (requires Corsica/QAT flight flag).
+
+### ntdll compression (vs `RtlCompressBuffer`)
+
+Windows `ntdll.dll` exposes a separate set of `CompressionFormatAndEngine` IDs used by SMB, NTFS, RDP, and other protocols. These use raw bitstreams with no ESE framing.
+
+| ntdll ID | Name | Decompress | Compress | Byte-Identical to ntdll | Builds |
+|----------|------|-----------|----------|------------------------|--------|
+| `0x0002` | LZNT1 | yes | yes | yes (ENGINE_MAX) | XP SP3 – Server 2025 |
+| `0x0003` | XPRESS (Plain LZ77) | yes | yes | yes | Win8.1 – Server 2025 |
+| `0x0004` | XPRESS_HUFF (LZ77+Huffman) | yes | yes | yes (default engine) | Win8.1 – Server 2025 |
+| `0x0005` | undocumented | — | — | — | Server 2022+ |
+| `0x0006` | XP10 (LZ4 block) | yes | yes | yes | Win11 / Server 2025 |
+| `0x0007` | raw DEFLATE | yes | yes | yes (both levels) | Win11 / Server 2025 |
+| `0x0008` | ZLIB | yes | yes | yes (both levels) | Win11 / Server 2025 |
+
+ntdll format 0x0005 is an undocumented format (block magic `0xC039E510`) unrelated to XPRESS9 despite sharing the slot number. No public specification or source code exists. Format 0x0006 (XP10) is the same LZ4 block codec used by ESE scheme 0x6 and 0x7, without the ESE header.
+
+## Design principles
+
+- **Standard library only at runtime.** No third-party dependencies. `zlib`/`lz4` are deliberately not used; the CRCs and the LZ4 block codec are implemented directly.
+- **Two subpackages, one interface pattern.** `ntcompress.ese` for ESE record-compression, `ntcompress.ntdll` for ntdll standalone codecs. Both offer Shape A (enum dispatch) and Shape B (direct module import) APIs.
+- **Traceable to a spec or a source line.** Every wire constant cites `[MS-XCA] §x.y` or an ESE `file:line`. Where the shipped C diverges from the spec text, both are documented.
+- **Byte-identical verification.** Compress output is verified against gold vectors captured from `esent.dll` and `ntdll.dll` on 16 Windows builds (XP SP3 through Server 2025).
+- **Typed and documented.** Python 3.11+, full type hints, Google-style docstrings, `ruff`-clean under `select = ["ALL"]`, `ty`-clean.
+
+## Installation
+
+```bash
+uv add ntcompress   # once published
+```
+
+Requires Python >= 3.11.
+
+## Usage
+
+### ESE record compression
+
+```python
+import ntcompress.ese as ese
+
+# Decompress a cell (format is in byte 0)
+plaintext = ese.decompress(cell)
+size = ese.decompressed_size(cell)
+
+# Compress with a specific format
+cell = ese.compress(plaintext, ese.Format.XPRESS)
+cell = ese.compress(plaintext, ese.Format.LZ4)
+cell = ese.compress(plaintext, ese.Format.XPRESS9)
+
+# Or use Shape B (direct module access)
+from ntcompress.ese import xpress
+cell = xpress.compress(plaintext)
+plaintext = xpress.decompress(cell)
+```
+
+### ntdll standalone codecs
+
+```python
+import ntcompress.ntdll as ntdll
+
+# Shape A (enum dispatch)
+compressed = ntdll.compress(data, ntdll.Format.LZNT1)
+plaintext = ntdll.decompress(compressed, ntdll.Format.LZNT1)
+
+# Windows constant aliases
+compressed = ntdll.compress(data, ntdll.COMPRESSION_FORMAT_XPRESS_HUFF)
+
+# Shape B (direct module access)
+from ntcompress.ntdll import lznt1, xpress_huff, deflate
+from ntcompress.ntdll import zlib as ntdll_zlib
+
+plaintext = lznt1.decompress(compressed_stream)
+compressed = xpress_huff.compress(data)
+compressed = deflate.compress(data)            # matches ntdll 0x0007
+compressed = ntdll_zlib.compress(data)         # matches ntdll 0x0008
+```
+
+## License and attribution
+
+Apache-2.0 (`LICENSE`). The XPRESS9 codec is an attributed port of Microsoft's MIT-licensed ESE source; the Plain LZ77, Xpress Huffman, and LZNT1 codecs are derived from the published `[MS-XCA]` specification; the LZ4 block codec follows the public LZ4 format. Full notices are in `THIRD-PARTY-NOTICES.md`.

ntcompress-0.1.0/README.md

@@ -0,0 +1,104 @@
+# ntcompress
+
+Pure-Python, standard-library-only implementations of every compression format used by Microsoft's Extensible Storage Engine (ESE/ESENT, the "JET Blue" engine behind `NTDS.dit`, Exchange stores, `Windows.edb`, `SRUDB.dat`, and `WebCacheV01.dat`) and Windows `ntdll.dll` compression (`RtlCompressBuffer` / `RtlDecompressBuffer`). No runtime dependencies beyond the standard library.
+
+## Scope
+
+This library covers two distinct compression layers used by Windows:
+
+### ESE record compression (vs `esent.dll`)
+
+ESE stores a one-byte header on each compressed record cell; the top 5 bits select the scheme (`first_byte >> 3`) and the low 3 bits carry scheme-specific flags.
+
+| ESE ID | Format | Decompress | Compress | Byte-Identical to esent.dll | Authority |
+|--------|--------|-----------|----------|---------------------------|-----------|
+| `0x0` | NONE (uncompressed sentinel) | — | — | — | `compression.cxx:504` |
+| `0x1` | 7-bit ASCII | yes | yes | yes | ESE source |
+| `0x2` | 7-bit Unicode | yes | yes | yes | ESE source |
+| `0x3` | XPRESS (Plain LZ77) | yes | yes | yes | `[MS-XCA] §2.3/2.4` |
+| `0x4` | SCRUB (erase marker) | produce | recognize | n/a | ESE source |
+| `0x5` | XPRESS9 | yes | yes | yes* | ESE MIT source (ported) |
+| `0x6` | XPRESS10 (LZ4 + CRC) | yes | yes | yes** | ESE source |
+| `0x7` | LZ4 (standard block) | yes | yes | yes | LZ4 block format |
+
+\*XPRESS9 encoder matches the MIT ESE C reference byte-for-byte excluding the non-deterministic session signature (`CRC32(__rdtsc())`), which even `esent.dll` varies on every call. \*\*XPRESS10 verified byte-identical by component construction (LZ4 block + CRC-32C + CRC-64/NVME each individually proven); not triggerable on commodity hardware (requires Corsica/QAT flight flag).
+
+### ntdll compression (vs `RtlCompressBuffer`)
+
+Windows `ntdll.dll` exposes a separate set of `CompressionFormatAndEngine` IDs used by SMB, NTFS, RDP, and other protocols. These use raw bitstreams with no ESE framing.
+
+| ntdll ID | Name | Decompress | Compress | Byte-Identical to ntdll | Builds |
+|----------|------|-----------|----------|------------------------|--------|
+| `0x0002` | LZNT1 | yes | yes | yes (ENGINE_MAX) | XP SP3 – Server 2025 |
+| `0x0003` | XPRESS (Plain LZ77) | yes | yes | yes | Win8.1 – Server 2025 |
+| `0x0004` | XPRESS_HUFF (LZ77+Huffman) | yes | yes | yes (default engine) | Win8.1 – Server 2025 |
+| `0x0005` | undocumented | — | — | — | Server 2022+ |
+| `0x0006` | XP10 (LZ4 block) | yes | yes | yes | Win11 / Server 2025 |
+| `0x0007` | raw DEFLATE | yes | yes | yes (both levels) | Win11 / Server 2025 |
+| `0x0008` | ZLIB | yes | yes | yes (both levels) | Win11 / Server 2025 |
+
+ntdll format 0x0005 is an undocumented format (block magic `0xC039E510`) unrelated to XPRESS9 despite sharing the slot number. No public specification or source code exists. Format 0x0006 (XP10) is the same LZ4 block codec used by ESE scheme 0x6 and 0x7, without the ESE header.
+
+## Design principles
+
+- **Standard library only at runtime.** No third-party dependencies. `zlib`/`lz4` are deliberately not used; the CRCs and the LZ4 block codec are implemented directly.
+- **Two subpackages, one interface pattern.** `ntcompress.ese` for ESE record-compression, `ntcompress.ntdll` for ntdll standalone codecs. Both offer Shape A (enum dispatch) and Shape B (direct module import) APIs.
+- **Traceable to a spec or a source line.** Every wire constant cites `[MS-XCA] §x.y` or an ESE `file:line`. Where the shipped C diverges from the spec text, both are documented.
+- **Byte-identical verification.** Compress output is verified against gold vectors captured from `esent.dll` and `ntdll.dll` on 16 Windows builds (XP SP3 through Server 2025).
+- **Typed and documented.** Python 3.11+, full type hints, Google-style docstrings, `ruff`-clean under `select = ["ALL"]`, `ty`-clean.
+
+## Installation
+
+```bash
+uv add ntcompress   # once published
+```
+
+Requires Python >= 3.11.
+
+## Usage
+
+### ESE record compression
+
+```python
+import ntcompress.ese as ese
+
+# Decompress a cell (format is in byte 0)
+plaintext = ese.decompress(cell)
+size = ese.decompressed_size(cell)
+
+# Compress with a specific format
+cell = ese.compress(plaintext, ese.Format.XPRESS)
+cell = ese.compress(plaintext, ese.Format.LZ4)
+cell = ese.compress(plaintext, ese.Format.XPRESS9)
+
+# Or use Shape B (direct module access)
+from ntcompress.ese import xpress
+cell = xpress.compress(plaintext)
+plaintext = xpress.decompress(cell)
+```
+
+### ntdll standalone codecs
+
+```python
+import ntcompress.ntdll as ntdll
+
+# Shape A (enum dispatch)
+compressed = ntdll.compress(data, ntdll.Format.LZNT1)
+plaintext = ntdll.decompress(compressed, ntdll.Format.LZNT1)
+
+# Windows constant aliases
+compressed = ntdll.compress(data, ntdll.COMPRESSION_FORMAT_XPRESS_HUFF)
+
+# Shape B (direct module access)
+from ntcompress.ntdll import lznt1, xpress_huff, deflate
+from ntcompress.ntdll import zlib as ntdll_zlib
+
+plaintext = lznt1.decompress(compressed_stream)
+compressed = xpress_huff.compress(data)
+compressed = deflate.compress(data)            # matches ntdll 0x0007
+compressed = ntdll_zlib.compress(data)         # matches ntdll 0x0008
+```
+
+## License and attribution
+
+Apache-2.0 (`LICENSE`). The XPRESS9 codec is an attributed port of Microsoft's MIT-licensed ESE source; the Plain LZ77, Xpress Huffman, and LZNT1 codecs are derived from the published `[MS-XCA]` specification; the LZ4 block codec follows the public LZ4 format. Full notices are in `THIRD-PARTY-NOTICES.md`.

ntcompress-0.1.0/pyproject.toml

@@ -0,0 +1,85 @@
+[project]
+name = "ntcompress"
+version = "0.1.0"
+description = "Pure-Python implementations of every Microsoft ESE record-compression scheme and Windows ntdll RtlCompressBuffer/RtlDecompressBuffer format."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+authors = [{ name = "ntcompress contributors" }]
+keywords = ["ese", "esent", "jet", "ntdll", "xpress", "xpress9", "xpress10", "lznt1", "lz4", "ms-xca", "compression", "forensics"]
+classifiers = [
+  "Development Status :: 2 - Pre-Alpha",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: 3 :: Only",
+  "Topic :: Security",
+  "Topic :: System :: Archiving :: Compression",
+  "Typing :: Typed",
+]
+dependencies = []
+
+[project.urls]
+Repository = "https://github.com/StrongWind1/ntcompress"
+Documentation = "https://strongwind1.github.io/ntcompress/"
+Changelog = "https://github.com/StrongWind1/ntcompress/blob/main/CHANGELOG.md"
+Issues = "https://github.com/StrongWind1/ntcompress/issues"
+
+[dependency-groups]
+dev = [
+    "pytest",
+    "hypothesis",
+    "ruff",
+    "ty",
+]
+docs = ["mkdocs", "mkdocs-material", "mkdocstrings[python]"]
+
+[build-system]
+requires = ["uv_build>=0.11.12,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.ruff]
+target-version = "py311"
+line-length = 320
+src = ["src"]
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "COM812",   # Trailing comma - conflicts with the ruff formatter
+    "ISC001",   # Implicit string concat - conflicts with the ruff formatter
+    "D203",     # No blank line before class docstring - conflicts with D211
+    "D213",     # Multi-line docstring summary on second line - conflicts with D212
+    "PLR0913",  # Too many arguments - wire-format and decoder functions legitimately need many params
+    "PLC0415",  # Import not at top level - deferred imports used pervasively for circular-import avoidance between ese/__init__.py and format modules
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["ALL"]
+"src/**/xpress9.py" = ["C901", "PLR0912", "PLR0915", "PLR2004"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ty.environment]
+python-version = "3.11"
+root = ["src"]
+
+[tool.ty.rules]
+all = "error"
+
+[tool.ty.terminal]
+error-on-warning = true
+
+[[tool.ty.overrides]]
+include = ["tests/**"]
+
+[tool.ty.overrides.rules]
+all = "ignore"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra"

ntcompress-0.1.0/src/ntcompress/__init__.py

@@ -0,0 +1,20 @@
+"""Pure-Python codecs for Microsoft ESE record-compression and Windows ntdll compression formats.
+
+``ntcompress`` compresses and decompresses all ESE record schemes (7-bit ASCII/Unicode,
+XPRESS, SCRUB, XPRESS9, XPRESS10, LZ4) and all supported ntdll ``RtlCompressBuffer``
+formats (LZNT1, XPRESS, XPRESS_HUFF, XP10, DEFLATE, ZLIB). Compress output is verified
+byte-identical to ``esent.dll`` and ``ntdll.dll`` across 16 Windows builds. No runtime
+dependencies beyond the standard library.
+
+ESE codecs live under :mod:`ntcompress.ese`; ntdll standalone codecs under
+:mod:`ntcompress.ntdll`.
+"""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("ntcompress")
+except PackageNotFoundError:  # pragma: no cover - source checkout without install metadata
+    __version__ = "0.0.0"

ntcompress-0.1.0/src/ntcompress/_types.py

@@ -0,0 +1,8 @@
+"""Shared type aliases used across both the ESE and ntdll subpackages."""
+
+from __future__ import annotations
+
+from typing import TypeAlias
+
+Buffer: TypeAlias = bytes | bytearray | memoryview
+"""Any read-only bytes-like input accepted by the codecs."""