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

Uploaded Python 3

File details

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

File metadata

  • Download URL: agent_first_data-0.14.0.tar.gz
  • Upload date:
  • Size: 28.2 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.14.0.tar.gz
Algorithm Hash digest
SHA256 8635c205bddb51b147c22eafe52d1092eb11fdba80395fab8d5aad49d4aae2d4
MD5 9f2d1086e885e65d502f1194d0cea056
BLAKE2b-256 b72a8afdcc163b70ef24f8433446c363675a59615761d7a8db0563e0dbda317d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for agent_first_data-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd34c39dbee7d386d15d09be88a00747f62a6ae26492ab24fceb3411ef6b24bb
MD5 7112b9d9b07e24bb151cc54cf22abc73
BLAKE2b-256 be0fee1d1f4e41e8493776f75bc3d267399a919772bac66ecbc0ba18d97b3577

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