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, 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.1.tar.gz (27.5 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.1-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: agent_first_data-0.13.1.tar.gz
  • Upload date:
  • Size: 27.5 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.1.tar.gz
Algorithm Hash digest
SHA256 629a36e4aa482309661722c536b74a1710cf67f9771245b508f430e2a52358cc
MD5 3ea4670a8a22c2069cabfbab90168504
BLAKE2b-256 a9bbea252321ddd1896a96fa1d973820634bd3eb12c667bed3344d53cebeaeb3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for agent_first_data-0.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 748bf419e80f06226f28d026b0f16550672c86dda54879aaf7afe8dbc5701136
MD5 f98a2ca45c9978b2b12266d0db57a0a6
BLAKE2b-256 0f5cce9e709ea9d165bb1502cb3e7df1c9239712bae902402d040d1e3b0eef54

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