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 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, 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, cli_handle_version_or_continue, 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:{}.
  • Use cli_handle_version_or_continue() before argument parsing so --version/-V always answers with a structured protocol-v1 kind:"result" version event — JSON by default, or --output yaml|plain/--json for another format; there is no conventional bare-text form. Pass your own value-taking global flag names so their value is not mistaken for the subcommand boundary.

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.23.0.tar.gz (35.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.23.0-py3-none-any.whl (25.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: agent_first_data-0.23.0.tar.gz
  • Upload date:
  • Size: 35.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.23.0.tar.gz
Algorithm Hash digest
SHA256 a5e0339737e39452f8cac33c629064838f4a65707611ac1b274b7181a03a8f19
MD5 f88169370ebbd6e0ecbfdd44cad659aa
BLAKE2b-256 96af38a81a04cecf25ea7c8eba2f7b437b107e26347217777c5c2a1d01c6d6f4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for agent_first_data-0.23.0-py3-none-any.whl
Algorithm Hash digest
SHA256 35a47bdd53fb3bb8cb0c529844b520e3a778582624c68c542cea32f43feeea0c
MD5 fee4645132f2dd1b838e6f4d2b3f0ae9
BLAKE2b-256 947684c6255f8c3a6a8342f6d9dcf41115d7cd349c90ba01d431d3fa08c31d70

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