adk-ledger 0.1.0__tar.gz

adk_ledger-0.1.0/.gitignore

@@ -0,0 +1,17 @@
+.venv/
+dist/
+build/
+*.egg-info/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.env
+.DS_Store
+.semgrep/
+semgrep.json
+semgrep.sarif
+.adk_ledger/
+AUDIT_FINDINGS.md
+examples/pyproject_config/logs/

adk_ledger-0.1.0/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+All notable changes to `adk-ledger` are recorded here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versions follow
+[Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-10-31
+
+First release.
+
+### Added
+
+- **Token metering** for every LLM call an ADK agent makes (`TokenMeterPlugin`) and for direct
+  `google.genai`, `openai` and `anthropic` SDK calls — by auto-instrumentation
+  (`instrument_genai` / `instrument_openai` / `instrument_anthropic`, streaming included) or
+  explicitly (`record_response`, `track_llm_call`, `@meter_llm_call`, `record_usage`).
+  Exact counts from the provider's `usage_metadata`: prompt, output, cached, cache writes,
+  thoughts, per-modality. ADK-issued and direct calls are never double counted; direct calls
+  made inside a tool are attributed to the agent, session and user that ran it.
+- **Cost attribution**, opt-in, on every event: Google's Cloud Billing catalog, the LiteLLM
+  price list, or your own `PriceTable`, composable; long-context tiers, cache discounts,
+  cache-write and per-modality rates, `savings` from caching. Unknown models are reported as
+  unpriced, never estimated.
+- **Tool-call metering** (`ToolMeterPlugin`): latency, errors, retries / loops (`attempt`),
+  argument and result sizes, long-running tools.
+- **Budgets** (`BudgetPlugin`): caps on tokens, cost, LLM calls or tool calls per global /
+  app / user / session / invocation / tag scope, optionally per calendar window; `warn`,
+  `block` (refuse the run, model call or tool call before it is made) or `raise`; dry-run;
+  optional user notices via the model or appended to the reply; `BudgetEvent`s to every sink.
+- **Cache effectiveness and context-window pressure**: cache hit ratio, "configured but never
+  hits" detection, dollars saved; prompt size against the model's input window
+  (`context_limit`, `context_utilization`) with limits from the Gemini API, LiteLLM or an
+  explicit table.
+- **Sinks**: `InMemorySink` (with per-model / agent / session aggregates), `JsonlSink`,
+  `OpenTelemetrySink` (metrics in the `adk_ledger.*` namespace with GenAI semantic-convention
+  attributes, plus span attributes), `CallbackSink`; any object with `emit()` / `close()` works.
+- **Configuration-first set-up**: `adk_ledger.setup()` reads `adk_ledger.toml` / YAML /
+  `[tool.adk_ledger]` in `pyproject.toml` and `ADK_LEDGER_*` environment variables; every key
+  maps 1:1 onto the imperative API (`configure()` and the plugin constructors). Invalid
+  configuration fails at start-up with a `ConfigError` naming the key.
+- **Tags**: `default_tags` and per-request `bind_tags()` on every event.
+- **Extension points**: custom sinks, custom provider extractors (`BaseUsageExtractor`,
+  also via the `adk_ledger.extractors` entry point), optional pre-call token estimators.
+
+### Notes
+
+- Events carry counts and identifiers only; prompt, response and tool payloads are never
+  recorded.
+- Requires Python ≥ 3.13 and `google-adk` ≥ 2.12.
+
+[Unreleased]: https://github.com/ravi-dalal/adk-ledger/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/ravi-dalal/adk-ledger/releases/tag/v0.1.0
+

adk_ledger-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,126 @@
+# Contributing to adk-ledger
+
+Development set-up, the test and lint tasks, security scanning, and how releases are made.
+For *using* the library see the [README](README.md) and [docs/](docs/).
+
+## Development
+
+This project uses [`mise`](https://mise.jdx.dev) + [`uv`](https://docs.astral.sh/uv/).
+
+```bash
+mise install && mise run install    # Python 3.13 + uv + .venv
+mise run test                       # pytest, all suites (no network needed)
+mise run test-unit                  # tests/unit — pure functions, sinks, config, pricing
+mise run test-integration           # tests/integration — real ADK Runner + fake models
+mise run test-smoke                 # tests/smoke — every example offline, adk web agent loads
+mise run lint                       # ruff + mypy --strict
+mise run format                     # ruff format
+mise run build                      # uv build → dist/
+mise run examples                   # every example, offline (no keys)
+mise run web                        # adk web with the concierge agent; needs GOOGLE_API_KEY or Agent Platform (GOOGLE_GENAI_USE_ENTERPRISE) env vars
+mise run bench                      # overhead benchmark -> docs/performance.md
+mise run scan                       # Trivy: CVEs in uv.lock, secrets, dependency licences (needs `trivy` on PATH)
+mise run semgrep                    # Semgrep: Python / GitHub-workflow / secrets rules (needs `semgrep` on PATH)
+mise run security                   # both
+mise run check                      # lint + test + build: what a release runs
+```
+
+Run anything else inside the environment with `uv run <cmd>`.
+
+### Test layout
+
+| suite | what it covers | needs |
+|---|---|---|
+| `tests/unit` | pure functions, sinks, config parsing, pricing math, extractors | nothing |
+| `tests/integration` | a real ADK `Runner` / `App` with fake models; the real `google-genai` / `openai` / `anthropic` SDKs with patched transports | nothing |
+| `tests/smoke` | every example runs offline (`ADK_LEDGER_EXAMPLE_OFFLINE=1`); the `adk web` agent loads | nothing |
+| `test_live_catalog` (skipped by default) | the real Cloud Billing catalog | `ADK_LEDGER_LIVE_GCP=1` + ADC or `GOOGLE_CLOUD_API_KEY` |
+
+Behavioural fixes come with a regression test that fails on the previous code. Two
+`UserWarning`s from ADK (`[EXPERIMENTAL] feature … is enabled`) are expected in the test
+output: ADK flags JSON-schema tool declarations and `ContextCacheConfig` as experimental.
+
+### Security scanning
+
+CI runs the same Trivy scan on every push / PR and weekly
+([`security.yml`](.github/workflows/security.yml); the SARIF report is attached to each run as an artifact),
+and the release workflow refuses to publish on HIGH/CRITICAL findings. Configuration is in
+[`trivy.yaml`](trivy.yaml).
+
+## Publishing
+
+### Use it locally from another project
+
+```bash
+# Editable install — edits in src/ are picked up immediately (best while developing)
+uv add --editable /path/to/adk_ledger          # consumer uses uv/pyproject
+uv pip install -e /path/to/adk_ledger          # or into any plain venv
+
+# Install the built wheel — exactly what PyPI users get
+mise run install-local /path/to/other/.venv
+
+# Local "index": drop wheels in a folder and resolve by name
+mise run build && mkdir -p ~/local-pypi && cp dist/* ~/local-pypi/
+uv pip install --find-links ~/local-pypi adk-ledger
+```
+
+### Release to PyPI (manual)
+
+1. Bump `version` in `pyproject.toml` and `src/adk_ledger/__init__.py` (PyPI never accepts the same version twice).
+2. Create an API token at <https://test.pypi.org/manage/account/token/> and
+   <https://pypi.org/manage/account/token/> (scope it to the project after the first upload).
+3. Dry-run on TestPyPI, then verify the install:
+
+   ```bash
+   UV_PUBLISH_TOKEN=pypi-… mise run publish-test       # lint + test + clean build + upload
+   uv pip install --index-url https://test.pypi.org/simple/ \
+                  --extra-index-url https://pypi.org/simple/ adk-ledger
+   ```
+
+4. Publish for real:
+
+   ```bash
+   UV_PUBLISH_TOKEN=pypi-… mise run publish
+   ```
+
+5. Tag and push: `git tag v0.1.0 && git push --tags`.
+
+### Release to PyPI (GitHub Actions, Trusted Publishing)
+
+[`.github/workflows/release.yml`](.github/workflows/release.yml) lints, tests, builds and
+uploads on every `v*` tag using OIDC — no token to store.
+
+One-time setup:
+
+1. On PyPI → *Account settings → Publishing → Add a new pending publisher*:
+   project `adk-ledger`, your GitHub owner, repo `adk-ledger`, workflow `release.yml`, environment `pypi`.
+2. On GitHub → *Settings → Environments* → create `pypi` (add required reviewers for an approval gate).
+3. The workflow must live at the **repository root** `.github/workflows/`; if this folder sits
+   inside a monorepo, move it there and set `defaults.run.working-directory` (see the comment in the file).
+
+Per release:
+
+```bash
+# bump version in pyproject.toml, commit, then
+git tag v0.1.0 && git push origin v0.1.0
+```
+
+The workflow fails fast if the tag doesn't match `project.version`.
+
+### Pre-flight checklist
+
+- Project name is free on PyPI (<https://pypi.org/project/adk-ledger/>).
+- `examples/` and `tests/` ship in the sdist — no `.env` files or keys in there.
+- `LICENSE` is present and listed in `license-files` (bundled into the wheel).
+- `mise run check` is green.
+- `CHANGELOG.md` has an entry for the version.
+
+## Roadmap ideas
+
+- Budget stores for Redis / ADK session state
+- Estimator-based budget reservation
+- Cache lifecycle metrics from explicit-cache refreshes
+- Claude-on-Agent-Platform SKUs in the Cloud Billing parser
+- BigQuery / Prometheus sinks
+- Invocation-level trajectory metrics
+

adk_ledger-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.