Skip to main content

A naming convention that lets AI agents understand your data without being told what it means, plus a CLI and library for reading Markdown structure and safely editing structured JSON, TOML, YAML, dotenv, and INI documents.

Project description

Agent-First Data for Python

pip install agent-first-data
from agent_first_data import json_result, render, OutputFormat

value = json_result(
    {
        "api_key_secret": "sk-123",
        "latency_ms": 1280,
        "db_url": "postgres://user:p@ss@db/app?token_secret=abc",
    }
).build()

print(render(value, OutputFormat.JSON))
print(render(value, OutputFormat.PLAIN))

Useful names use Python casing: render (the single value x format x options -> str entry point; takes an OutputFormat and an optional keyword-only options=), redacted_value, redact_url_secrets, redact_argv, normalize_utc_offset, is_valid_rfc3339_date, is_valid_rfc3339_time, is_valid_rfc3339, is_valid_bcp47, cli_parse_output, build_cli_error, build_cli_version, decode_protocol_event.

Behavior Notes

  • Default redaction replaces every _secret or configured secret-name subtree with ***, including objects and arrays.
  • _url fields scrub userinfo passwords and secret-named query parameters; surrounding whitespace is trimmed and internal whitespace redacts the whole field.
  • YAML keeps original keys and values (structure-preserving, like JSON), sorting keys by UTF-16 code unit order and quoting/escaping unsafe keys and string scalars. Plain strips formatting suffixes, formats values, sorts the same way, and renders nested objects/arrays as canonical JSON.
  • Logging records use kind:"log" with a nested log payload and a separate level field, so error-level logs are not terminal protocol errors.
  • build_cli_error(message, hint?) returns a strict-ready CLI error with error.retryable:false and trace:{}.
  • Do not add a raw version/help pre-parser. Until the Python CliSpec compiler lands, applications should keep lifecycle parsing in their own parser rather than claim AFDATA closed-world help compatibility.

Reference

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agent_first_data-0.29.1.tar.gz (44.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agent_first_data-0.29.1-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

Details for the file agent_first_data-0.29.1.tar.gz.

File metadata

  • Download URL: agent_first_data-0.29.1.tar.gz
  • Upload date:
  • Size: 44.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for agent_first_data-0.29.1.tar.gz
Algorithm Hash digest
SHA256 dfefc1bc97375bc58f272d218fa254da21c6eefed8ddd05b999b627e350f92fa
MD5 12de47d90b7418ca5f3a3ebb864bd9b2
BLAKE2b-256 844b9ce1a0757f1801dad42bb75def107e620690a12512aa8aa3f7826747ca70

See more details on using hashes here.

File details

Details for the file agent_first_data-0.29.1-py3-none-any.whl.

File metadata

File hashes

Hashes for agent_first_data-0.29.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f6f8e43ca9e85a9d2ac210fe64bea5e081712f32bfda17894e1a544cbfc36395
MD5 60be98aae72d32035f9eb0bcd56dd0a8
BLAKE2b-256 fb73ca2a52f39f6883dd4eb781f8d299af0c564ecac7fc54ab8c55b3555d3539

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page