Skip to main content

A naming convention that lets AI agents understand your data without being told what it means.

Project description

Agent-First Data for Python

pip install agent-first-data
from agent_first_data import output_json, output_plain

value = {
    "code": "ok",
    "result": {
        "api_key_secret": "sk-123",
        "latency_ms": 1280,
        "db_url": "postgres://user:p@ss@db/app?token_secret=abc",
    },
}

print(output_json(value))
print(output_plain(value))

Useful names use Python casing: output_json, output_yaml, output_plain, output_json_with_options, redacted_value, redact_secrets_in_place, redact_url_secrets, parse_size, normalize_utc_offset, is_valid_rfc3339_date, is_valid_rfc3339_time, cli_parse_output, cli_output, build_cli_error, build_cli_version, and cli_handle_version_or_continue.

Logging is available through init_logging_json, init_logging_plain, init_logging_yaml, span, and get_logger.

from agent_first_data import init_logging_json

init_logging_json("INFO", secret_names=("authorization",))

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/plain quote and escape keys as well as values, sort by UTF-16 code unit order, and render nested objects in arrays as canonical JSON.
  • Logging records use code: "log" plus a separate level field, so error-level logs are not terminal protocol errors.
  • build_cli_error(message, hint?) returns {code:"error", error: message, hint?} only.
  • Use cli_handle_version_or_continue() before argument parsing so bare --version stays conventional and --version --output json|yaml|plain stays structured.

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.13.2.tar.gz (28.1 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.13.2-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: agent_first_data-0.13.2.tar.gz
  • Upload date:
  • Size: 28.1 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.13.2.tar.gz
Algorithm Hash digest
SHA256 04d62c6c1dd7879a3e908c8843af4a3003876098a3876989d0aece354b4c4c87
MD5 f25a8d326908a5e7afd7bb9c36ff9233
BLAKE2b-256 9dcc55862c63173b56e0f361653fdfcb6a68337bbc350af76bb45b388fcebd42

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for agent_first_data-0.13.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2dbef748c3faf5e1484153971d63f408b3a0efc1f986d77299d8d106ce7de11c
MD5 a49d079640227266547962567a528e47
BLAKE2b-256 4ce16af1005c16017290f110c5f44ab23403937cf33e920f06e6255fed063968

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