agent-first-data 0.2.2__tar.gz → 0.2.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: agent-first-data
3
- Version: 0.2.2
3
+ Version: 0.2.4
4
4
  Summary: Agent-First Data (AFD) — suffix-driven output formatting and protocol templates for AI agents
5
5
  License-Expression: MIT
6
6
  Project-URL: Repository, https://github.com/cmnspore/agent-first-data
@@ -19,6 +19,44 @@ The field name is the schema. Agents read `latency_ms` and know milliseconds, `a
19
19
  pip install agent-first-data
20
20
  ```
21
21
 
22
+ ## Quick Example
23
+
24
+ A backup tool invoked from the CLI — flags, env vars, and config all use the same suffixes:
25
+
26
+ ```bash
27
+ API_KEY_SECRET=sk-1234 cloudback --timeout-s 30 --max-file-size-bytes 10737418240 /data/backup.tar.gz
28
+ ```
29
+
30
+ The tool reads env vars, flags, and config — all with AFD suffixes — and emits a startup message:
31
+
32
+ ```python
33
+ from agent_first_data import *
34
+ import os
35
+
36
+ startup = build_json_startup(
37
+ {"timeout_s": 30, "max_file_size_bytes": 10737418240},
38
+ {"input_path": "/data/backup.tar.gz"},
39
+ {"API_KEY_SECRET": os.environ.get("API_KEY_SECRET")},
40
+ )
41
+ ```
42
+
43
+ Three output formats, same data:
44
+
45
+ ```
46
+ JSON: {"code":"startup","args":{"input_path":"/data/backup.tar.gz"},"config":{"max_file_size_bytes":10737418240,"timeout_s":30},"env":{"API_KEY_SECRET":"***"}}
47
+ YAML: code: "startup"
48
+ args:
49
+ input_path: "/data/backup.tar.gz"
50
+ config:
51
+ max_file_size: "10.0GB"
52
+ timeout: "30s"
53
+ env:
54
+ API_KEY: "***"
55
+ Plain: args.input_path=/data/backup.tar.gz code=startup config.max_file_size=10.0GB config.timeout=30s env.API_KEY=***
56
+ ```
57
+
58
+ `--timeout-s` → `timeout_s` → `timeout: 30s`. `API_KEY_SECRET` → `API_KEY: "***"`. The suffix is the schema.
59
+
22
60
  ## API Reference
23
61
 
24
62
  Total: **9 public APIs** + **AFD logging** (4 protocol builders + 3 output functions + 1 internal + 1 utility)
@@ -402,6 +440,21 @@ All formats automatically redact `_secret` fields.
402
440
  - **Currency**: `_msats`, `_sats`, `_btc`, `_usd_cents`, `_eur_cents`, `_jpy`, `_{code}_cents`
403
441
  - **Other**: `_percent`, `_secret` (auto-redacted in all formats)
404
442
 
443
+ ## Repository
444
+
445
+ This package is part of the [agent-first-data](https://github.com/cmnspore/agent-first-data) repository, which also contains:
446
+
447
+ - **`spec/`** — Full AFD specification with suffix definitions, protocol format rules, and cross-language test fixtures
448
+ - **`skills/`** — Claude Code skill for AI agents working with AFD conventions
449
+
450
+ To run tests, clone the full repository (tests use shared cross-language fixtures from `spec/fixtures/`):
451
+
452
+ ```bash
453
+ git clone https://github.com/cmnspore/agent-first-data
454
+ cd agent-first-data/python
455
+ python -m pytest
456
+ ```
457
+
405
458
  ## License
406
459
 
407
460
  MIT
@@ -10,6 +10,44 @@ The field name is the schema. Agents read `latency_ms` and know milliseconds, `a
10
10
  pip install agent-first-data
11
11
  ```
12
12
 
13
+ ## Quick Example
14
+
15
+ A backup tool invoked from the CLI — flags, env vars, and config all use the same suffixes:
16
+
17
+ ```bash
18
+ API_KEY_SECRET=sk-1234 cloudback --timeout-s 30 --max-file-size-bytes 10737418240 /data/backup.tar.gz
19
+ ```
20
+
21
+ The tool reads env vars, flags, and config — all with AFD suffixes — and emits a startup message:
22
+
23
+ ```python
24
+ from agent_first_data import *
25
+ import os
26
+
27
+ startup = build_json_startup(
28
+ {"timeout_s": 30, "max_file_size_bytes": 10737418240},
29
+ {"input_path": "/data/backup.tar.gz"},
30
+ {"API_KEY_SECRET": os.environ.get("API_KEY_SECRET")},
31
+ )
32
+ ```
33
+
34
+ Three output formats, same data:
35
+
36
+ ```
37
+ JSON: {"code":"startup","args":{"input_path":"/data/backup.tar.gz"},"config":{"max_file_size_bytes":10737418240,"timeout_s":30},"env":{"API_KEY_SECRET":"***"}}
38
+ YAML: code: "startup"
39
+ args:
40
+ input_path: "/data/backup.tar.gz"
41
+ config:
42
+ max_file_size: "10.0GB"
43
+ timeout: "30s"
44
+ env:
45
+ API_KEY: "***"
46
+ Plain: args.input_path=/data/backup.tar.gz code=startup config.max_file_size=10.0GB config.timeout=30s env.API_KEY=***
47
+ ```
48
+
49
+ `--timeout-s` → `timeout_s` → `timeout: 30s`. `API_KEY_SECRET` → `API_KEY: "***"`. The suffix is the schema.
50
+
13
51
  ## API Reference
14
52
 
15
53
  Total: **9 public APIs** + **AFD logging** (4 protocol builders + 3 output functions + 1 internal + 1 utility)
@@ -393,6 +431,21 @@ All formats automatically redact `_secret` fields.
393
431
  - **Currency**: `_msats`, `_sats`, `_btc`, `_usd_cents`, `_eur_cents`, `_jpy`, `_{code}_cents`
394
432
  - **Other**: `_percent`, `_secret` (auto-redacted in all formats)
395
433
 
434
+ ## Repository
435
+
436
+ This package is part of the [agent-first-data](https://github.com/cmnspore/agent-first-data) repository, which also contains:
437
+
438
+ - **`spec/`** — Full AFD specification with suffix definitions, protocol format rules, and cross-language test fixtures
439
+ - **`skills/`** — Claude Code skill for AI agents working with AFD conventions
440
+
441
+ To run tests, clone the full repository (tests use shared cross-language fixtures from `spec/fixtures/`):
442
+
443
+ ```bash
444
+ git clone https://github.com/cmnspore/agent-first-data
445
+ cd agent-first-data/python
446
+ python -m pytest
447
+ ```
448
+
396
449
  ## License
397
450
 
398
451
  MIT
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: agent-first-data
3
- Version: 0.2.2
3
+ Version: 0.2.4
4
4
  Summary: Agent-First Data (AFD) — suffix-driven output formatting and protocol templates for AI agents
5
5
  License-Expression: MIT
6
6
  Project-URL: Repository, https://github.com/cmnspore/agent-first-data
@@ -19,6 +19,44 @@ The field name is the schema. Agents read `latency_ms` and know milliseconds, `a
19
19
  pip install agent-first-data
20
20
  ```
21
21
 
22
+ ## Quick Example
23
+
24
+ A backup tool invoked from the CLI — flags, env vars, and config all use the same suffixes:
25
+
26
+ ```bash
27
+ API_KEY_SECRET=sk-1234 cloudback --timeout-s 30 --max-file-size-bytes 10737418240 /data/backup.tar.gz
28
+ ```
29
+
30
+ The tool reads env vars, flags, and config — all with AFD suffixes — and emits a startup message:
31
+
32
+ ```python
33
+ from agent_first_data import *
34
+ import os
35
+
36
+ startup = build_json_startup(
37
+ {"timeout_s": 30, "max_file_size_bytes": 10737418240},
38
+ {"input_path": "/data/backup.tar.gz"},
39
+ {"API_KEY_SECRET": os.environ.get("API_KEY_SECRET")},
40
+ )
41
+ ```
42
+
43
+ Three output formats, same data:
44
+
45
+ ```
46
+ JSON: {"code":"startup","args":{"input_path":"/data/backup.tar.gz"},"config":{"max_file_size_bytes":10737418240,"timeout_s":30},"env":{"API_KEY_SECRET":"***"}}
47
+ YAML: code: "startup"
48
+ args:
49
+ input_path: "/data/backup.tar.gz"
50
+ config:
51
+ max_file_size: "10.0GB"
52
+ timeout: "30s"
53
+ env:
54
+ API_KEY: "***"
55
+ Plain: args.input_path=/data/backup.tar.gz code=startup config.max_file_size=10.0GB config.timeout=30s env.API_KEY=***
56
+ ```
57
+
58
+ `--timeout-s` → `timeout_s` → `timeout: 30s`. `API_KEY_SECRET` → `API_KEY: "***"`. The suffix is the schema.
59
+
22
60
  ## API Reference
23
61
 
24
62
  Total: **9 public APIs** + **AFD logging** (4 protocol builders + 3 output functions + 1 internal + 1 utility)
@@ -402,6 +440,21 @@ All formats automatically redact `_secret` fields.
402
440
  - **Currency**: `_msats`, `_sats`, `_btc`, `_usd_cents`, `_eur_cents`, `_jpy`, `_{code}_cents`
403
441
  - **Other**: `_percent`, `_secret` (auto-redacted in all formats)
404
442
 
443
+ ## Repository
444
+
445
+ This package is part of the [agent-first-data](https://github.com/cmnspore/agent-first-data) repository, which also contains:
446
+
447
+ - **`spec/`** — Full AFD specification with suffix definitions, protocol format rules, and cross-language test fixtures
448
+ - **`skills/`** — Claude Code skill for AI agents working with AFD conventions
449
+
450
+ To run tests, clone the full repository (tests use shared cross-language fixtures from `spec/fixtures/`):
451
+
452
+ ```bash
453
+ git clone https://github.com/cmnspore/agent-first-data
454
+ cd agent-first-data/python
455
+ python -m pytest
456
+ ```
457
+
405
458
  ## License
406
459
 
407
460
  MIT
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "agent-first-data"
3
- version = "0.2.2"
3
+ version = "0.2.4"
4
4
  description = "Agent-First Data (AFD) — suffix-driven output formatting and protocol templates for AI agents"
5
5
  license = "MIT"
6
6
  readme = "README.md"