headson 0.6.3__cp310-abi3-macosx_11_0_arm64.whl → 0.6.5__cp310-abi3-macosx_11_0_arm64.whl

{headson-0.6.3.dist-info → headson-0.6.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: headson
-Version: 0.6.3
+Version: 0.6.5
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Rust
@@ -20,12 +20,15 @@ Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
   <br/>
 </p>
 
-`heal`/`tail` for JSON, YAML - but structure‑aware. Get a compact preview that shows both the shape and representative values of your data, all within a strict character budget. (Just like `head`/`tail`, `headson` can also work with unstructured text files.)
+`heal`/`tail` for JSON, YAML - but structure‑aware. Get a compact preview that shows both the shape and representative values of your data, all within a strict byte budget. (Just like `head`/`tail`, `headson` can also work with unstructured text files.)
 
 Available as:
 - CLI (see [Usage](#usage))
 - Python library (see [Python Bindings](#python-bindings))
 
+![Codecov](https://img.shields.io/codecov/c/github/kantord/headson?style=flat-square) ![Crates.io Version](https://img.shields.io/crates/v/headson?style=flat-square) ![PyPI - Version](https://img.shields.io/pypi/v/headson?style=flat-square)
+
+
 ## Install
 
 Using Cargo:
@@ -67,8 +70,8 @@ If you’re comfortable with tools like `head` and `tail`, use `headson` when yo
 
 Common flags:
 
-- `-n, --budget <BYTES>`: per‑file output budget. For multiple inputs, default total budget is `<BYTES> * number_of_inputs`.
-- `-N, --global-budget <BYTES>`: total output budget across all inputs. With `--budget`, the effective total is the smaller of the two.
+- `-c, --bytes <BYTES>`: per‑file output budget. For multiple inputs, default total budget is `<BYTES> * number_of_inputs`.
+- `-C, --global-bytes <BYTES>`: total output budget across all inputs. With `--bytes`, the effective total is the smaller of the two.
 - `-f, --format <auto|json|yaml|text>`: output format (default: `auto`).
   - Auto: stdin → JSON family; filesets → per‑file based on extension (`.json` → JSON family, `.yaml`/`.yml` → YAML, unknown → Text).
 - `-t, --template <strict|default|detailed>`: output style (default: `default`).
@@ -89,7 +92,7 @@ Notes:
   - With newlines enabled, file sections are rendered with human‑readable headers. In compact/single‑line modes, headers are omitted.
 - In `--format auto`, each file uses its own best format: JSON family for `.json`, YAML for `.yaml`/`.yml`.
   - Unknown extensions are treated as Text (raw lines) — safe for logs and `.txt` files.
-  - `--global-budget` may truncate or omit entire files to respect the total budget.
+  - `--global-bytes` may truncate or omit entire files to respect the total budget.
   - The tool finds the largest preview that fits the budget; even if extremely tight, you still get a minimal, valid preview.
   - Directories and binary files are ignored; a notice is printed to stderr for each. Stdin reads the stream as‑is.
   - Head vs Tail sampling: these options bias which part of arrays are kept before rendering. Display styles may still insert internal gap markers to honor very small budgets; strict JSON stays unannotated.
@@ -98,33 +101,33 @@ Quick one‑liners:
 
 - Peek a big JSON stream (keeps structure):
 
-      zstdcat huge.json.zst | headson -n 800 -f json -t default
+      zstdcat huge.json.zst | headson -c 800 -f json -t default
 
 - Many files with a fixed overall size:
 
-      headson -N 1200 -f json -t strict logs/*.json
+      headson -C 1200 -f json -t strict logs/*.json
 
 - Glance at a file, JavaScript‑style comments for omissions:
 
-      headson -n 400 -f json -t detailed data.json
+      headson -c 400 -f json -t detailed data.json
 
 - YAML with detailed comments:
 
-      headson -n 400 -f yaml -t detailed config.yaml
+      headson -c 400 -f yaml -t detailed config.yaml
 
 ### Text mode
 
 - Single file (auto):
 
-      headson -n 200 notes.txt
+      headson -c 200 notes.txt
 
 - Force Text ingest/output (useful when mixing with other extensions):
 
-      headson -n 200 -i text -f text notes.txt
+      headson -c 200 -i text -f text notes.txt
 
 - Many text files (fileset):
 
-      headson -n 800 -i text -f text logs/*.txt
+      headson -c 800 -i text -f text logs/*.txt
 
 - Styles on Text:
   - default: omission as a standalone `…` line.
@@ -135,6 +138,8 @@ Show help:
 
     headson --help
 
+Note: flags align with head/tail conventions (`-c/--bytes`, `-C/--global-bytes`).
+
 ## Examples: head vs headson
 
 Input:
@@ -153,7 +158,7 @@ jq -c . users.json | head -c 80
 Structured preview with headson (JSON family, default style → Pseudo):
 
 ```bash
-headson -n 120 -f json -t default users.json
+headson -c 120 -f json -t default users.json
 # {
 #   users: [
 #     { id: 1, name: "Ana", roles: [ "admin", … ] },
@@ -166,7 +171,7 @@ headson -n 120 -f json -t default users.json
 Machine‑readable preview (JSON family, strict style → strict JSON):
 
 ```bash
-headson -n 120 -f json -t strict users.json
+headson -c 120 -f json -t strict users.json
 # {"users":[{"id":1,"name":"Ana","roles":["admin"]}],"meta":{"count":2}}
 ```
 
@@ -185,11 +190,11 @@ A thin Python extension module is available on PyPI as `headson`.
 
 - Install: `pip install headson` (ABI3 wheels for Python 3.10+ on Linux/macOS/Windows).
 - API:
-  - `headson.summarize(text: str, *, format: str = "auto", style: str = "default", input_format: str = "json", character_budget: int | None = None, skew: str = "balanced") -> str`
+  - `headson.summarize(text: str, *, format: str = "auto", style: str = "default", input_format: str = "json", byte_budget: int | None = None, skew: str = "balanced") -> str`
     - `format`: `"auto" | "json" | "yaml"` (auto maps to JSON family for single inputs)
     - `style`: `"strict" | "default" | "detailed"`
     - `input_format`: `"json" | "yaml"` (ingestion)
-    - `character_budget`: maximum output size in characters (default: 500)
+    - `byte_budget`: maximum output size in bytes (default: 500)
     - `skew`: `"balanced" | "head" | "tail"` (affects display styles; strict JSON remains unannotated)
 
 Examples:
@@ -199,7 +204,7 @@ import json
 import headson
 
 data = {"foo": [1, 2, 3], "bar": {"x": "y"}}
-preview = headson.summarize(json.dumps(data), format="json", style="strict", character_budget=200)
+preview = headson.summarize(json.dumps(data), format="json", style="strict", byte_budget=200)
 print(preview)
 
 # Prefer the tail of arrays (annotations show with style="default"/"detailed")
@@ -208,14 +213,14 @@ print(
         json.dumps(list(range(100))),
         format="json",
         style="detailed",
-        character_budget=80,
+        byte_budget=80,
         skew="tail",
     )
 )
 
 # YAML support
 doc = "root:\n  items: [1,2,3,4,5,6,7,8,9,10]\n"
-print(headson.summarize(doc, format="yaml", style="default", input_format="yaml", character_budget=60))
+print(headson.summarize(doc, format="yaml", style="default", input_format="yaml", byte_budget=60))
 ```
 
 # Algorithm
@@ -225,7 +230,7 @@ print(headson.summarize(doc, format="yaml", style="default", input_format="yaml"
 ## Footnotes
  - <sup><b>[1]</b></sup> <b>Optimized tree representation</b>: An arena‑style tree stored in flat, contiguous buffers. Each node records its kind and value plus index ranges into shared child and key arrays. Arrays are ingested in a single pass and may be deterministically pre‑sampled: the first element is always kept; additional elements are selected via a fixed per‑index inclusion test; for kept elements, original indices are stored and full lengths are counted. This enables accurate omission info and internal gap markers later, while minimizing pointer chasing.
  - <sup><b>[2]</b></sup> <b>Priority order</b>: Nodes are scored so previews surface representative structure and values first. Arrays can favor head/mid/tail coverage (default) or strictly the head; tail preference flips head/tail when configured. Object properties are ordered by key, and strings expand by grapheme with early characters prioritized over very deep expansions.
- - <sup><b>[3]</b></sup> <b>Choose top N nodes (binary search)</b>: Iteratively picks N so that the rendered preview fits within the character budget, looping between “choose N” and a render attempt to converge quickly.
+ - <sup><b>[3]</b></sup> <b>Choose top N nodes (binary search)</b>: Iteratively picks N so that the rendered preview fits within the byte budget, looping between “choose N” and a render attempt to converge quickly.
  - <sup><b>[4]</b></sup> <b>Render attempt</b>: Serializes the currently included nodes using the selected template. Omission summaries and per-file section headers appear in display templates (pseudo/js); json remains strict. For arrays, display templates may insert internal gap markers between non‑contiguous kept items using original indices.
  - <sup><b>[5]</b></sup> <b>Diagram source</b>: The Algorithm diagram is generated from `docs/diagrams/algorithm.mmd`. Regenerate the SVG with `cargo make diagrams` before releasing.
 

headson-0.6.5.dist-info/RECORD

@@ -0,0 +1,5 @@
+headson-0.6.5.dist-info/METADATA,sha256=TnCNEuY5-ExHHo3f2U3IG5fXljO04XKaaSebi24vhCg,10782
+headson-0.6.5.dist-info/WHEEL,sha256=-lwEpi49KOTCcgx48T3fLSP8Dxynwa-iRMZNo-JZaqc,103
+headson/__init__.py,sha256=Z-vwzLN9ptomZrtRqVUuUKSAaidOSVcjFI6Ojbuj-dU,219
+headson/headson.abi3.so,sha256=EIawdIcq2XrElDWbhmY5VMIWKPmUR3BNfFjsKSR6oCA,853408
+headson-0.6.5.dist-info/RECORD,,

headson-0.6.3.dist-info/RECORD

@@ -1,5 +0,0 @@
-headson-0.6.3.dist-info/METADATA,sha256=-XUXLS7kujupBt2kqNLMoKyx6GJmbq0E415Nh_Qs7xk,10500
-headson-0.6.3.dist-info/WHEEL,sha256=-lwEpi49KOTCcgx48T3fLSP8Dxynwa-iRMZNo-JZaqc,103
-headson/__init__.py,sha256=Z-vwzLN9ptomZrtRqVUuUKSAaidOSVcjFI6Ojbuj-dU,219
-headson/headson.abi3.so,sha256=-BlSgXzSGKMPZcFekoLb4pfuIhPfs27yfCIcZ-2c4_8,853440
-headson-0.6.3.dist-info/RECORD,,