headson 0.6.2__cp310-abi3-win_amd64.whl → 0.6.4__cp310-abi3-win_amd64.whl

{headson-0.6.2.dist-info → headson-0.6.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: headson
-Version: 0.6.2
+Version: 0.6.4
 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>
 
-Head/tail for JSON and 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.
+`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.)
 
 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:
@@ -41,10 +44,11 @@ From source:
 ## Features
 
 - Budgeted output: specify exactly how much you want to see
-- Output formats: `auto | json | yaml`
+- Output formats: `auto | json | yaml | text`
   - Styles: `strict | default | detailed`
     - JSON family: `strict` → strict JSON, `default` → human‑friendly Pseudo, `detailed` → JS with inline comments
     - YAML: always YAML; `strict` has no comments, `default` uses “# …”, `detailed` uses “# N more …”
+    - Text: prints raw lines. In `default` style, omissions are shown as a single line `…`; in `detailed`, as `… N more lines …`. `strict` omits array‑level summaries.
 - Multiple inputs: preview many files at once with a shared or per‑file budget
 - Fast: processes gigabyte‑scale files in seconds (mostly disk‑bound)
 - Available as a CLI app and as a Python library
@@ -66,14 +70,14 @@ 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.
-- `-f, --format <auto|json|yaml>`: output format (default: `auto`).
-  - Auto: stdin → JSON family; filesets → per‑file based on extension (`.json` → JSON family, `.yaml`/`.yml` → YAML).
+- `-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`).
   - JSON family: `strict` → strict JSON; `default` → Pseudo; `detailed` → JS with inline comments.
   - YAML: always YAML; style only affects comments (`strict` none, `default` “# …”, `detailed` “# N more …”).
-- `-i, --input-format <json|yaml>`: ingestion format (default: `json`). For filesets in `auto` format, ingestion is chosen by extensions.
+- `-i, --input-format <json|yaml|text>`: ingestion format (default: `json`). For filesets in `auto` format, ingestion is chosen by extensions.
 - `-m, --compact`: no indentation, no spaces, no newlines
 - `--no-newline`: single line output
 - `--no-space`: no space after `:` in objects
@@ -86,8 +90,9 @@ Notes:
 
 - Multiple inputs:
   - 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`.
-  - `--global-budget` may truncate or omit entire files to respect the total budget.
+- 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-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.
@@ -96,24 +101,45 @@ 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 -c 200 notes.txt
+
+- Force Text ingest/output (useful when mixing with other extensions):
+
+      headson -c 200 -i text -f text notes.txt
+
+- Many text files (fileset):
+
+      headson -c 800 -i text -f text logs/*.txt
+
+- Styles on Text:
+  - default: omission as a standalone `…` line.
+  - detailed: omission as `… N more lines …`.
+  - strict: no array‑level omission line (individual long lines may still truncate with `…`).
 
 Show help:
 
     headson --help
 
+Note: flags align with head/tail conventions (`-c/--bytes`, `-C/--global-bytes`).
+
 ## Examples: head vs headson
 
 Input:
@@ -132,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", … ] },
@@ -145,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}}
 ```
 
@@ -157,6 +183,7 @@ Regenerate locally:
 - Run: cargo make tapes
 - Outputs are written to docs/assets/tapes
 
+
 ## Python Bindings
 
 A thin Python extension module is available on PyPI as `headson`.

headson-0.6.4.dist-info/RECORD

@@ -0,0 +1,5 @@
+headson-0.6.4.dist-info/METADATA,sha256=WidNGP3zBXfDNvrIPAB8NZqPfTgXIDcSgzBNqwh3084,11047
+headson-0.6.4.dist-info/WHEEL,sha256=4EDp_7DiFfWl1yYv5M4wSosAn5L_xgD1dyrQxQxfCx8,95
+headson/__init__.py,sha256=Z-vwzLN9ptomZrtRqVUuUKSAaidOSVcjFI6Ojbuj-dU,219
+headson/headson.pyd,sha256=pJox3PeWAH6Vqj9L7uh4GDUpTPKkwcRwrNz193sH1bE,762880
+headson-0.6.4.dist-info/RECORD,,

headson-0.6.2.dist-info/RECORD

@@ -1,5 +0,0 @@
-headson-0.6.2.dist-info/METADATA,sha256=JhObjCQ0LKxqCUg2YdJlE272hAKGob8KhXCcyh0Pa2s,9831
-headson-0.6.2.dist-info/WHEEL,sha256=4EDp_7DiFfWl1yYv5M4wSosAn5L_xgD1dyrQxQxfCx8,95
-headson/__init__.py,sha256=Z-vwzLN9ptomZrtRqVUuUKSAaidOSVcjFI6Ojbuj-dU,219
-headson/headson.pyd,sha256=1u6Iy8XUOfv_zPDCcGp5Sht0CRrgYBQ5Sav2GNw1Cwg,762368
-headson-0.6.2.dist-info/RECORD,,