c4py 1.0.0__tar.gz

c4py-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: python -m pytest

c4py-1.0.0/.gitignore

@@ -0,0 +1,17 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+.venv/
+venv/
+*.so
+.DS_Store

c4py-1.0.0/DEVELOPMENT.md

@@ -0,0 +1,217 @@
+# c4py Development Guide
+
+This document specifies the implementation requirements for c4py. The project is scaffolded — module skeletons with docstrings and type signatures exist, test vectors from the Go reference implementation are provided, and test files are ready.
+
+## Architecture
+
+```
+src/c4py/
+  __init__.py      # Public API (complete — re-exports from modules)
+  id.py            # C4 ID computation (IMPLEMENTED — 27/27 cross-language tests pass)
+  store.py         # Content store (IMPLEMENTED — 13/13 tests pass, adaptive trie sharding)
+  entry.py         # Entry dataclass (partial — formatting TODO)
+  manifest.py      # Manifest type (skeleton)
+  decoder.py       # c4m parser (skeleton)
+  encoder.py       # c4m writer (skeleton)
+  naturalsort.py   # Natural sort (skeleton)
+  safename.py      # Filename encoding (skeleton)
+  scanner.py       # Directory scanner (skeleton)
+  diff.py          # Diff operations (skeleton)
+  validator.py     # Validation (skeleton)
+```
+
+## CLI Alignment (c4 v1.0.0)
+
+c4py maps to the c4 CLI (8 commands: id, cat, diff, patch, merge, log, split, version).
+
+| c4py function | c4 CLI | Description |
+|---------------|--------|-------------|
+| `identify()` / `scan()` | `c4 id` | Identify content, scan directories |
+| `store.get()` | `c4 cat` | Retrieve content by C4 ID |
+| `patch_diff()` | `c4 diff` | Produce c4m patch between two states |
+| `resolve_chain()` | `c4 patch` | Resolve patch chain to final state |
+| `merge()` | `c4 merge` | Three-way merge with LWW conflict resolution |
+| `log_chain()` | `c4 log` | Enumerate patches in a chain |
+| `diff()` | — | High-level comparison (added/removed/modified) |
+
+Key interop points:
+- **Shared content store:** TreeStore adaptive trie, same config (`C4_STORE` / `~/.c4/config`).
+- **`scan(store=...)` maps to `c4 id -s`:** Single-pass identify + store.
+- **Canonical output matches `c4 id`:** `c4py.dumps(manifest)` produces byte-identical output.
+- **Reconciliation:** The Go CLI has `github.com/Avalanche-io/c4/reconcile` for applying manifest state to directories. c4py does not replicate this — use the CLI for filesystem reconciliation.
+
+## Implementation Priority
+
+### Phase 1: Core (must ship in v0.1.0)
+
+1. **id.py** — DONE. C4 ID computation, parsing, tree IDs. 27/27 cross-language tests pass.
+
+2. **store.py** — DONE. FSStore with adaptive trie sharding, open_store() config
+   discovery, ContentNotFound error. 13/13 tests pass. Compatible with Go CLI layout.
+
+3. **naturalsort.py** — Implement `natural_sort_key()`.
+   - Split names into alternating text/numeric segments
+   - Numeric: compare as integers, then by string length for ties
+   - Text sorts before numeric in mixed comparisons
+   - Reference: `/Users/joshua/ws/active/c4/oss/c4/c4m/naturalsort.go`
+   - Tests: `tests/test_naturalsort.py`
+
+4. **safename.py** — Implement all four functions.
+   - Tier 1: printable UTF-8 passthrough (except `¤` U+00A4 and `\`)
+   - Tier 2: `\0`, `\t`, `\n`, `\r`, `\\`
+   - Tier 3: non-printable → braille U+2800-U+28FF between `¤` delimiters
+   - Field escaping: space→`\ `, `"`→`\"`, `[`→`\[`, `]`→`\]`
+   - Reference: `/Users/joshua/ws/active/c4/oss/c4/c4m/safename.go`
+
+5. **entry.py** — Complete `format_mode()` and `canonical()`.
+   - Mode string: 10 chars, position 0 = file type, 1-9 = rwx with special bits
+   - Use Python's `stat` module constants for bit extraction
+   - Null mode (0) → `-`
+   - Reference: `/Users/joshua/ws/active/c4/oss/c4/c4m/entry.go`
+
+6. **decoder.py** — Implement `loads()` and `load()`.
+   - Parse entry lines: split fields, handle indentation
+   - Auto-detect indent width from first indented line
+   - Handle null values: `-` for mode, timestamp, size, c4id
+   - Parse timestamps: accept RFC3339 (canonical) and common variations
+   - Handle link operators: symlinks, hard links, flow links
+   - Reject @ directives, CR characters, invalid UTF-8
+   - Skip inline ID list lines (range data): len > 90, len % 90 == 0, all 90-char
+     chunks are valid C4 IDs. These are NOT patch boundaries.
+   - Bare C4 ID lines (exactly 90 chars) are patch boundaries
+   - Reference: `/Users/joshua/ws/active/c4/oss/c4/c4m/decoder.go`
+   - Reference: `/Users/joshua/ws/active/c4/oss/c4/c4m/chain.go`
+
+7. **encoder.py** — Implement `dumps()` and `dump()`.
+   - Canonical mode: no indent, single spaces, UTC, null as `-`
+   - Pretty mode: indented, padded sizes, column-aligned C4 IDs
+   - Pretty column: default 80, shift to next 10-col boundary if needed
+   - Reference: `/Users/joshua/ws/active/c4/oss/c4/c4m/encoder.go`
+
+8. **manifest.py** — Complete `sort_entries()` and `compute_c4id()`.
+   - Sort: files before directories at each depth, then natural sort
+   - C4 ID: format all entries canonical, hash the UTF-8 bytes
+   - Reference: `/Users/joshua/ws/active/c4/oss/c4/c4m/manifest.go`
+
+9. **scanner.py** — Implement `scan()`.
+   - Walk directory with `os.walk()` or `pathlib`
+   - Stat each file for mode, timestamp, size
+   - Compute C4 ID for regular files (streaming)
+   - When `store` is provided: tee read stream to store.put() (single pass,
+     zero extra I/O). This matches `c4 id -s` in the CLI.
+   - Record symlink targets
+   - Build entry tree with correct depth
+   - Sort and compute directory C4 IDs bottom-up
+   - Reference: `/Users/joshua/ws/active/c4/oss/c4/c4m/builder.go`
+
+10. **diff.py** — Implement all functions:
+    - `diff(a, b)` — high-level comparison: match by path, categorize as
+      added/removed/modified/same
+    - `patch_diff(old, new)` — produce c4m patch text. First line is bare C4 ID
+      of old (base state). Patch entry semantics: exact duplicate = removal,
+      same path different content = modification, new path = addition.
+      Maps to: `c4 diff before.c4m after.c4m`
+    - `apply_patch(base, entries)` — apply patch entries to base manifest
+    - `resolve_chain(manifest)` — resolve all patches to final state.
+      Maps to: `c4 patch project.c4m`
+    - `log_chain(manifest)` — enumerate patches with summary stats.
+      Maps to: `c4 log project.c4m`
+    - Reference: `/Users/joshua/ws/active/c4/oss/c4/c4m/operations.go`
+    - Reference: `/Users/joshua/ws/active/c4/oss/c4/design/cli/phase1_cli_redesign.md`
+
+11. **validator.py** — Implement `validate()`.
+    - Check for duplicate paths
+    - Check for path traversal (`../`, `./`)
+    - Check indentation consistency
+    - Check mode string format
+    - Check timestamp format
+    - Check C4 ID format (90 chars, c4 prefix, base58)
+    - Check directory names end with /
+    - Verify bare C4 ID patch boundaries match accumulated content
+    - Reference: `/Users/joshua/ws/active/c4/oss/c4/c4m/validator.go`
+
+### Phase 2: Polish (v0.1.0 nice-to-have)
+
+- Sequence notation parsing (frame.[0001-0100].exr)
+- Pretty-print with local timezone detection
+- `c4 split` equivalent (extract patch range from chain)
+
+### Phase 3: Future (v0.2.0+)
+
+- Network client integration (absorb current c4-python code)
+- c4git Python API
+- Performance: optional C extension for SHA-512 (hashlib is already C-backed)
+
+## Cross-Language Compatibility
+
+**This is the most critical requirement.** c4py must produce byte-identical output to the Go reference implementation for:
+
+1. C4 ID strings (given same input bytes)
+2. Canonical c4m text (given same manifest)
+3. Natural sort order (given same entry names)
+4. Manifest C4 IDs (given same directory contents)
+
+Test vectors are in `tests/vectors/known_ids.json`, generated from the Go implementation.
+
+To generate additional test vectors:
+```bash
+cd /Users/joshua/ws/active/c4/oss/c4
+go run /tmp/c4vectors.go
+```
+
+## Running Tests
+
+```bash
+cd /Users/joshua/ws/active/c4/oss/c4py
+pip install -e ".[dev]"
+pytest
+pytest --cov=c4py
+mypy src/
+ruff check src/ tests/
+```
+
+## Code Style
+
+- Python 3.10+ (use `X | Y` union syntax, not `Union[X, Y]`)
+- Type annotations on all public functions
+- mypy strict mode must pass
+- ruff for linting
+- No external dependencies (stdlib only)
+- Docstrings on all public classes and functions
+- Keep it minimal — match the C4 philosophy
+
+## Key Design Decisions
+
+- **Pure Python, zero dependencies.** hashlib.sha512 is C-backed and fast enough.
+- **Streaming identification.** `identify()` reads in chunks, constant memory.
+- **Immutable C4ID.** The digest is set once at construction.
+- **Lenient parser, strict encoder.** Accept variations, always output canonical.
+- **Cross-language tests are the spec.** If Go produces X for input Y, c4py must too.
+
+## Reference Files
+
+All paths are in the Go reference implementation at `/Users/joshua/ws/active/c4/oss/c4/`:
+
+| Module | Go Reference |
+|--------|-------------|
+| id.py | `id.go` (C4ID, Parse, Identify) |
+| store.py | `store/treestore.go`, `store/config.go` |
+| entry.py | `c4m/entry.go` |
+| manifest.py | `c4m/manifest.go` |
+| decoder.py | `c4m/decoder.go`, `c4m/chain.go` (patch chain parsing) |
+| encoder.py | `c4m/encoder.go` |
+| naturalsort.py | `c4m/naturalsort.go` |
+| safename.py | `c4m/safename.go` |
+| scanner.py | `cmd/c4/internal/scan/` (progressive scanner with modes) |
+| diff.py | `c4m/operations.go` (PatchDiff, ApplyPatch, Diff), `c4m/chain.go` (ResolvePatchChain), `c4m/merge.go` (Merge) |
+| validator.py | `c4m/validator.go` |
+
+**Key specs:**
+- c4m format: `c4m/SPECIFICATION.md`
+- c4m standard (ABNF grammar): `c4m/C4M-STANDARD.md`
+- Unix recipes: `docs/c4m-unix-recipes.md`
+
+**Note:** The c4 v1.0.0 release (branch `release/v1.0`) contains 6 packages:
+`c4`, `c4m`, `store`, `reconcile`, `cmd/c4`, `cmd/c4/internal/scan`.
+Non-essential packages (chunk, transform, db, hashlib, progscan) were stripped.
+Only depend on APIs from the shipping packages.

c4py-1.0.0/LICENSE

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

c4py-1.0.0/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: c4py
+Version: 1.0.0
+Summary: C4 universal content identification — SMPTE ST 2114:2017
+Project-URL: Homepage, https://github.com/Avalanche-io/c4py
+Project-URL: Documentation, https://github.com/Avalanche-io/c4py
+Project-URL: Repository, https://github.com/Avalanche-io/c4py
+Project-URL: Issues, https://github.com/Avalanche-io/c4py/issues
+Author-email: Joshua Kolden <joshua@avalanche.io>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: c4,c4m,content-addressing,hash,identification,manifest,smpte
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Filesystems
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# c4py
+
+[![CI](https://github.com/Avalanche-io/c4py/actions/workflows/ci.yml/badge.svg)](https://github.com/Avalanche-io/c4py/actions/workflows/ci.yml)
+[![Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](./LICENSE)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org)
+[![Tests](https://img.shields.io/badge/tests-418-brightgreen.svg)](./tests)
+
+Pure Python implementation of [C4](https://github.com/Avalanche-io/c4) universal content identification (SMPTE ST 2114:2017).
+
+```python
+import c4py
+
+# Verify a delivery matches the manifest
+manifest = c4py.load("delivery-v3.c4m")
+for path, entry in manifest.flat_entries():
+    if entry.c4id and not c4py.verify(f"/deliveries/v3/{path}", entry.c4id):
+        print(f"MISMATCH: {path}")
+
+# Identify any file — same content always produces the same ID
+c4id = c4py.identify_file("render.1001.exr")
+
+# Compare two snapshots of a project
+old = c4py.load("delivery-v2.c4m")
+new = c4py.load("delivery-v3.c4m")
+diff = c4py.diff(old, new)
+print(f"+{len(diff.added)} -{len(diff.removed)} ~{len(diff.modified)}")
+```
+
+## Install
+
+```bash
+pip install c4py
+```
+
+## What is C4?
+
+C4 IDs are universally unique, unforgeable identifiers derived from content using SHA-512. They are standardized as [SMPTE ST 2114:2017](https://ieeexplore.ieee.org/document/7971777). Same content always produces the same 90-character ID, regardless of filename, location, or time.
+
+```python
+>>> import c4py
+>>> c4py.identify_bytes(b"hello world")
+C4ID('c41yP4cqy7jmaRDzC2bmcGNZkuQb3VdftMk6YH7ynQ2Qw4zktKsyA9fk52xghNQNAdkpF9iFmFkKh2bNVG4kDWhsok')
+```
+
+## C4M Format
+
+A **c4m file** is a human-readable text file that describes a filesystem. It captures file names, sizes, permissions, timestamps, and C4 IDs in a format you can read, edit, diff, and email.
+
+```
+-rw-r--r-- 2025-06-15T12:00:00Z      3 README.md   c45xZeXwMSpq...
+drwxr-xr-x 2025-06-15T12:00:00Z      3 src/        -
+  -rw-r--r-- 2025-06-15T12:00:00Z    3 main.go     c45KgBYEvEE7...
+```
+
+A 2 KB c4m file can describe an 8 TB project. Compare two c4m files to find exactly which frames changed across a delivery — in seconds, not hours.
+
+## API
+
+### Identification
+
+```python
+# Identify a file on disk
+c4id = c4py.identify_file("render.1001.exr")
+
+# Verify a file matches an expected ID
+assert c4py.verify("render.1001.exr", expected_id)
+
+# From file-like object (streaming, constant memory)
+c4id = c4py.identify(file_obj)
+
+# From bytes
+c4id = c4py.identify_bytes(b"data")
+
+# Parse a C4 ID string (also works as C4ID constructor)
+c4id = c4py.parse("c45xZeXwMSpq...")
+c4id = c4py.C4ID("c45xZeXwMSpq...")  # same thing
+
+# C4 ID properties
+str(c4id)       # 90-character string
+bytes(c4id)     # 64-byte digest
+c4id.hex()      # hex digest
+bool(c4id)      # False for nil ID, True otherwise
+```
+
+### Tree IDs (Set Identity)
+
+```python
+# Compute a single ID for a set of IDs (order-independent)
+tree_id = c4py.tree_id([id_a, id_b, id_c])
+```
+
+### C4M Files
+
+```python
+# Parse
+manifest = c4py.load("project.c4m")
+manifest = c4py.loads(text)
+
+# Write
+c4py.dump(manifest, file_obj)
+text = c4py.dumps(manifest)
+text = c4py.dumps(manifest, pretty=True)
+
+# Scan directory
+manifest = c4py.scan("/path/to/dir")
+
+# Iterate entries
+for entry in manifest:
+    print(entry.name, entry.size, entry.c4id)
+```
+
+### Content Store
+
+c4py shares the same content store as the `c4` CLI and `c4sh`. Content stored by any tool is immediately available to the others.
+
+```python
+# Open a store (auto-discovers from C4_STORE env or ~/.c4/config)
+store = c4py.open_store()
+
+# Or specify a path
+store = c4py.open_store("/data/c4store")
+
+# Store and retrieve content
+c4id = store.put(open("render.exr", "rb"))
+assert store.has(c4id)
+content = store.get(c4id)
+
+# Scan + store in one pass (zero extra I/O)
+manifest = c4py.scan("/projects/HERO", store=store)
+```
+
+### Diff and Patch Chains
+
+```python
+# Compare two manifests
+diff = c4py.diff(old_manifest, new_manifest)
+diff.added      # entries only in new
+diff.removed    # entries only in old
+diff.modified   # same path, different content
+diff.same       # identical entries
+
+# Produce a c4m patch (like `c4 diff before.c4m after.c4m`)
+patch_text = c4py.patch_diff(old_manifest, new_manifest)
+
+# c4m files can contain version histories (base + patches)
+# Resolve a chain to its final state (like `c4 patch project.c4m`)
+final = c4py.resolve_chain(manifest)
+
+# Enumerate patches (like `c4 log project.c4m`)
+for info in c4py.log_chain(manifest):
+    print(f"{info.index}  {info.c4id}  +{info.added} -{info.removed} ~{info.modified}")
+```
+
+### Validation
+
+```python
+result = c4py.validate(manifest)
+for issue in result.errors:
+    print(issue)
+```
+
+## Works With
+
+c4py is part of the [C4 ecosystem](https://github.com/Avalanche-io/c4):
+
+- **[c4](https://github.com/Avalanche-io/c4)** — Go CLI for identification and content storage (`c4 id`, `c4 cat`, `c4 diff`)
+- **[c4sh](https://github.com/Avalanche-io/c4sh)** — Shell integration that makes c4m files behave as directories
+- **[c4git](https://github.com/Avalanche-io/c4git)** — Git clean/smudge filter for large media assets
+
+All tools share the same content store and produce identical C4 IDs.
+
+## Compatibility
+
+c4py produces byte-identical output to the [Go reference implementation](https://github.com/Avalanche-io/c4). Cross-language test vectors ensure this.
+
+Zero external dependencies. Pure Python. Works offline.
+
+## Design Decisions
+
+See the [FAQ](https://github.com/Avalanche-io/c4/blob/main/docs/faq.md) for design decisions including SHA-512 permanence, the c4m format, and content store scaling.
+
+## License
+
+MIT