commitkv 1.0.1__tar.gz

commitkv-1.0.1/LICENSE

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

commitkv-1.0.1/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: commitkv
+Version: 1.0.1
+License-File: LICENSE
+Summary: Compressed key-value store for git-managed caches: append-only segments that never exceed a size limit
+License-Expression: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Issues, https://github.com/WillBooster/commitkv/issues
+Project-URL: Repository, https://github.com/WillBooster/commitkv
+
+# commitkv
+
+A compressed key-value store for caches that are committed to git, usable from Python,
+Node.js, and Bun.
+
+- **No file ever exceeds a size limit.** Records are appended to segment files; before a record
+  is written, a segment that it would push past the limit (32 MiB by default) is closed and a
+  new one is started. A record that cannot fit even in an empty segment is rejected.
+- **Git-friendly.** Segments are only ever appended to, and only by the checkout that created
+  them: a segment that arrived through git (a clone, another worktree, a checkout of another
+  branch) is never changed. Branches that both add records therefore add different files and
+  merge without conflicts.
+- **Compressed without training.** Every value is coded with zstd against the values stored
+  before it in the same segment, so values that resemble each other (prompts built from one
+  template, API responses of one shape) cost little after the first few. There is no
+  dictionary to train and nothing to configure.
+- **Safe to share.** One store may be used from several threads, and several stores, in one
+  process or many, may use the same directory at once.
+
+commitkv supports Linux (glibc 2.17 or newer) and macOS, on x86_64 and arm64.
+
+## Installation
+
+For Node.js and Bun, install the npm package. It includes prebuilt Node-API addons for all
+four supported platforms; Rust is not required.
+
+```bash
+npm install commitkv
+# or
+bun add commitkv
+```
+
+For Python 3.10 or newer, install the PyPI package. Wheels for the same four platforms do
+not require Rust; installing from source requires a Rust toolchain.
+
+```bash
+pip install commitkv
+```
+
+## Usage
+
+A `str` / `string` key or value stands for its UTF-8 encoding; values are returned as bytes.
+
+```python
+from commitkv import Store
+
+store = Store("cache")                 # or Store("cache", max_segment_bytes=16 * 1024 * 1024)
+store.put("key", "value")
+store.get("key")                       # b"value"; None when the key is absent
+"key" in store, len(store), store.keys()
+store.refresh()                        # pick up what other stores wrote to the directory
+```
+
+```ts
+import { Store } from 'commitkv';
+
+const store = new Store('cache'); // or new Store('cache', { maxSegmentBytes: 16 * 1024 * 1024 })
+store.put('key', 'value');
+store.get('key')?.toString(); // 'value'; undefined when the key is absent
+(store.has('key'), store.size, store.keys());
+store.refresh(); // pick up what other stores wrote to the directory
+```
+
+## Behavior
+
+- `put` replaces every value of the key that the store has seen. The earlier records stay in
+  their segments: commitkv never deletes or compacts.
+- A store reads the directory when it opens, when `refresh` is called, and when a `put` starts
+  writing (the first `put`, and the first after a failed one); records that other stores write
+  stay invisible until one of those happens. Call `refresh` after
+  replacing segments under an open store, for example by checking out another branch.
+- Among records of a key that stores wrote without seeing each other's, which one wins is
+  unspecified, but every reader picks the same one.
+- `max_segment_bytes` / `maxSegmentBytes` must be between 1,024 and 100,000,000; the upper
+  bound keeps every file under GitHub's 100 MB limit.
+- An option out of range and a record that does not fit in a segment raise `ValueError` in
+  Python and an error whose `code` is `'InvalidArg'` in TypeScript. An I/O failure raises
+  `OSError` and a corrupt store `RuntimeError`; both have the `code` `'GenericFailure'`.
+- A record is written with one `write` call and is not synced to disk. After a crash, a store
+  ignores a record that was only partly written and everything else remains readable.
+- Each record carries a CRC-32 that is checked whenever it is read.
+- A store that starts writing continues the newest segment when the same directory wrote it
+  last and no other store is writing to it, so short runs do not each leave a small file behind.
+  The directory remembers this in `.commitkv-writer`, which commitkv lists in a `.gitignore` it keeps
+  in the directory; commit that `.gitignore` with the segments.
+- `get` decodes the values written around the requested one and those at the start of its
+  segment (about 1 MiB each, more when single values are larger) and keeps recently decoded
+  values in memory.
+
+## Development
+
+```bash
+mise install               # bun, node, rust, uv
+bun install
+bun run build              # builds the platform addon and the dist/ that `import 'commitkv'` resolves to
+bun wb test                # Bun tests of the TypeScript API, and pytest through `uv run`
+cargo test --release --manifest-path rust/Cargo.toml
+```
+
+The tests load the platform addon from `native/`: after changing Rust code, rerun `bun run build/native`,
+which builds only that. `uv run` rebuilds the Python extension module by itself.
+
+`cargo run --release --manifest-path rust/Cargo.toml --example lines -- <file>` stores every
+line of a file as a value and reports the stored size and the throughput.
+
+Layout: `rust/crates/commitkv` is the store, `rust/crates/commitkv-node` the Node-API addon that
+`src/index.ts` wraps, and `rust/crates/commitkv-python` the extension module that `python/commitkv`
+re-exports and types.
+
+Read [docs/format.md](docs/format.md) before changing how segments are written or read: it is
+the contract that keeps existing caches readable.
+
+Read [docs/releasing.md](docs/releasing.md) when publishing locally or retrying a Python release.
+

commitkv-1.0.1/README.md

@@ -0,0 +1,113 @@
+# commitkv
+
+A compressed key-value store for caches that are committed to git, usable from Python,
+Node.js, and Bun.
+
+- **No file ever exceeds a size limit.** Records are appended to segment files; before a record
+  is written, a segment that it would push past the limit (32 MiB by default) is closed and a
+  new one is started. A record that cannot fit even in an empty segment is rejected.
+- **Git-friendly.** Segments are only ever appended to, and only by the checkout that created
+  them: a segment that arrived through git (a clone, another worktree, a checkout of another
+  branch) is never changed. Branches that both add records therefore add different files and
+  merge without conflicts.
+- **Compressed without training.** Every value is coded with zstd against the values stored
+  before it in the same segment, so values that resemble each other (prompts built from one
+  template, API responses of one shape) cost little after the first few. There is no
+  dictionary to train and nothing to configure.
+- **Safe to share.** One store may be used from several threads, and several stores, in one
+  process or many, may use the same directory at once.
+
+commitkv supports Linux (glibc 2.17 or newer) and macOS, on x86_64 and arm64.
+
+## Installation
+
+For Node.js and Bun, install the npm package. It includes prebuilt Node-API addons for all
+four supported platforms; Rust is not required.
+
+```bash
+npm install commitkv
+# or
+bun add commitkv
+```
+
+For Python 3.10 or newer, install the PyPI package. Wheels for the same four platforms do
+not require Rust; installing from source requires a Rust toolchain.
+
+```bash
+pip install commitkv
+```
+
+## Usage
+
+A `str` / `string` key or value stands for its UTF-8 encoding; values are returned as bytes.
+
+```python
+from commitkv import Store
+
+store = Store("cache")                 # or Store("cache", max_segment_bytes=16 * 1024 * 1024)
+store.put("key", "value")
+store.get("key")                       # b"value"; None when the key is absent
+"key" in store, len(store), store.keys()
+store.refresh()                        # pick up what other stores wrote to the directory
+```
+
+```ts
+import { Store } from 'commitkv';
+
+const store = new Store('cache'); // or new Store('cache', { maxSegmentBytes: 16 * 1024 * 1024 })
+store.put('key', 'value');
+store.get('key')?.toString(); // 'value'; undefined when the key is absent
+(store.has('key'), store.size, store.keys());
+store.refresh(); // pick up what other stores wrote to the directory
+```
+
+## Behavior
+
+- `put` replaces every value of the key that the store has seen. The earlier records stay in
+  their segments: commitkv never deletes or compacts.
+- A store reads the directory when it opens, when `refresh` is called, and when a `put` starts
+  writing (the first `put`, and the first after a failed one); records that other stores write
+  stay invisible until one of those happens. Call `refresh` after
+  replacing segments under an open store, for example by checking out another branch.
+- Among records of a key that stores wrote without seeing each other's, which one wins is
+  unspecified, but every reader picks the same one.
+- `max_segment_bytes` / `maxSegmentBytes` must be between 1,024 and 100,000,000; the upper
+  bound keeps every file under GitHub's 100 MB limit.
+- An option out of range and a record that does not fit in a segment raise `ValueError` in
+  Python and an error whose `code` is `'InvalidArg'` in TypeScript. An I/O failure raises
+  `OSError` and a corrupt store `RuntimeError`; both have the `code` `'GenericFailure'`.
+- A record is written with one `write` call and is not synced to disk. After a crash, a store
+  ignores a record that was only partly written and everything else remains readable.
+- Each record carries a CRC-32 that is checked whenever it is read.
+- A store that starts writing continues the newest segment when the same directory wrote it
+  last and no other store is writing to it, so short runs do not each leave a small file behind.
+  The directory remembers this in `.commitkv-writer`, which commitkv lists in a `.gitignore` it keeps
+  in the directory; commit that `.gitignore` with the segments.
+- `get` decodes the values written around the requested one and those at the start of its
+  segment (about 1 MiB each, more when single values are larger) and keeps recently decoded
+  values in memory.
+
+## Development
+
+```bash
+mise install               # bun, node, rust, uv
+bun install
+bun run build              # builds the platform addon and the dist/ that `import 'commitkv'` resolves to
+bun wb test                # Bun tests of the TypeScript API, and pytest through `uv run`
+cargo test --release --manifest-path rust/Cargo.toml
+```
+
+The tests load the platform addon from `native/`: after changing Rust code, rerun `bun run build/native`,
+which builds only that. `uv run` rebuilds the Python extension module by itself.
+
+`cargo run --release --manifest-path rust/Cargo.toml --example lines -- <file>` stores every
+line of a file as a value and reports the stored size and the throughput.
+
+Layout: `rust/crates/commitkv` is the store, `rust/crates/commitkv-node` the Node-API addon that
+`src/index.ts` wraps, and `rust/crates/commitkv-python` the extension module that `python/commitkv`
+re-exports and types.
+
+Read [docs/format.md](docs/format.md) before changing how segments are written or read: it is
+the contract that keeps existing caches readable.
+
+Read [docs/releasing.md](docs/releasing.md) when publishing locally or retrying a Python release.

commitkv-1.0.1/pyproject.toml

@@ -0,0 +1,34 @@
+[project]
+name = "commitkv"
+version = "1.0.1"
+description = "Compressed key-value store for git-managed caches: append-only segments that never exceed a size limit"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+
+[project.urls]
+Repository = "https://github.com/WillBooster/commitkv"
+Issues = "https://github.com/WillBooster/commitkv/issues"
+
+[dependency-groups]
+dev = ["pytest>=8"]
+
+[build-system]
+requires = ["maturin>=1.9,<2"]
+build-backend = "maturin"
+
+[tool.maturin]
+manifest-path = "rust/crates/commitkv-python/Cargo.toml"
+python-source = "python"
+module-name = "commitkv._native"
+include = [{ path = "LICENSE", format = "sdist" }]
+
+# Rebuild the extension module when the Rust sources or manifests change.
+[tool.uv]
+cache-keys = [
+  { file = "pyproject.toml" },
+  { file = "rust/Cargo.lock" },
+  { file = "rust/Cargo.toml" },
+  { file = "rust/crates/**/Cargo.toml" },
+  { file = "rust/crates/**/*.rs" },
+]

commitkv-1.0.1/python/commitkv/__init__.py

@@ -0,0 +1,3 @@
+from ._native import Store
+
+__all__ = ["Store"]

commitkv-1.0.1/python/commitkv/_native.pyi

@@ -0,0 +1,30 @@
+from os import PathLike
+from typing import final
+
+@final
+class Store:
+    """A directory of compressed segments, none of which exceeds ``max_segment_bytes``
+    (32 MiB by default; ``ValueError`` unless between 1,024 and 100,000,000).
+
+    A ``str`` key or value stands for its UTF-8 encoding. A store may be shared by threads,
+    and several stores, in one process or many, may use the same directory at once.
+
+    Every method may raise ``OSError`` for an I/O failure and ``RuntimeError`` for a corrupt
+    store.
+    """
+
+    def __init__(
+        self, directory: str | PathLike[str], *, max_segment_bytes: int = ...
+    ) -> None: ...
+    def get(self, key: str | bytes) -> bytes | None: ...
+    def put(self, key: str | bytes, value: str | bytes) -> None:
+        """Stores a value, replacing an earlier one.
+
+        Raises ``ValueError`` when the record does not fit in a segment.
+        """
+
+    def __contains__(self, key: str | bytes) -> bool: ...
+    def __len__(self) -> int: ...
+    def keys(self) -> list[bytes]: ...
+    def refresh(self) -> None:
+        """Picks up records that other stores wrote to the directory."""