docs: strengthen agent-facing README so v2 APIs are not treated as current - #1879
Conversation
…rrent Coding agents still use Langfuse().trace() and GET /api/public/traces after pip install langfuse. Put the current OTEL APIs, Observations/Metrics v2 links, and the 10-minute freshness SLO in the first screen of the README. Co-authored-by: Cursor <cursoragent@cursor.com>
|
@claude review |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Claude Code Review
No review was started: this request came from a bot account. Manual reviews can only be requested by someone with write access to this repository. Ask a maintainer to comment @claude review, or have your automation post the comment from a user account with write access.
Tip: disable this comment in your organization's Code Review settings.
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
LGTM, straightforward documentation/metadata change.
What was reviewed: the new README [!IMPORTANT] banner text and its links, removal of the old v4-migration callout under Installation (now folded into the new banner), the two new doc links appended at the bottom, and the pyproject.toml description string update. No code paths are touched; links point to existing langfuse.com/api.reference.langfuse.com domains and the wording is consistent with the PR description.
Extended reasoning...
Overview
The change touches only README.md and pyproject.toml. It replaces a small "v4 migration" callout under Installation with a more detailed [!IMPORTANT] banner near the top of the README that clarifies the v2 client API is deprecated, points to get_client()/start_as_current_observation/@ observe, links the Observations API v2 and Metrics API v2, and states a data-freshness note. Two documentation links were appended at the bottom of the README, and the pyproject.toml package description was updated to mention v4/OpenTelemetry and the tracing APIs.
Security risks
None. This is pure documentation and package metadata text; no code, dependencies, build configuration, or CI logic changed. There is no injection, auth, or data-exposure surface here.
Level of scrutiny
Low. This is exactly the kind of mechanical, self-contained documentation/metadata update that does not require deep review — no logic changes, no ambiguous design decisions, and the diff is small and easy to fully read in one pass.
Other factors
No CLAUDE.md conventions apply, no CODEOWNERS concerns are evident for README/pyproject metadata, and there are no outstanding review threads or third-party objections in the timeline. The bug-hunting pass reported no findings, consistent with the low-risk nature of the change.
…nstructor Keep the March 2026 migration callout in the banner, drop Langfuse() from the deprecated v2 API list, and restore the previous PyPI description. Co-authored-by: Cursor <cursoragent@cursor.com>
2 participants
Summary
[!IMPORTANT]banner so agents cannot miss that the current Python SDK is v4 OpenTelemetry (get_client()/start_as_current_observation), not the legacy v2 client (Langfuse(),trace(),span(),generation(),api.trace.list).pip install langfuse) and point at current docs plus the v2→v3 / v3→v4 upgrade guides.langfuse>= 4.7.0, or any OTel exporter sendingx-langfuse-ingestion-version: 4) combined with the Observations API v2 and Metrics API v2. All other GET APIs from all SDK versions can be up to 10 minutes behind.descriptionso registry metadata names v4 / OTEL / those tracing APIs.Python counterpart of langfuse/langfuse-js#952. Companions: v2-stable and v3-stable PRs with the identical query/freshness wording.
Test plan
README.mdand confirm agent-facing install + read-API guidance is presentMade with Cursor
The PR should not merge until the banner stops identifying the supported public
Langfuse()v4 constructor as a deprecated legacy API.Summary
This PR expands the README’s introductory guidance and package metadata to emphasize the v4 OpenTelemetry SDK.
Langfuse()v4 constructor as deprecated.Reviews (1) · Last reviewed commit: "docs: strengthen agent-facing README so ..."