Skip to content

docs: point the README at the v5 SDK and its migration guide #2009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jayfeng7 wants to merge 5 commits into
base: main
Choose a base branch
from
Open

docs: point the README at the v5 SDK and its migration guide #2009

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2ff0812
docs: point the README at the v5 SDK and its migration guide
jayfeng7 Oct 15, 2026
79a2039
Merge branch 'main' into docs/readme-point-at-v5-migration
jayfeng7 Oct 19, 2026
36c005e
Merge branch 'main' into docs/readme-point-at-v5-migration
jayfeng7 Oct 21, 2026
94d32d2
Merge branch 'main' into docs/readme-point-at-v5-migration
jayfeng7 Oct 21, 2026
20514f6
Merge branch 'main' into docs/readme-point-at-v5-migration
jayfeng7 Oct 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@
[![YC W23](https://img.shields.io/badge/Y%20Combinator-W23-orange?style=flat-square)](https://www.ycombinator.com/companies/langfuse)

> [!IMPORTANT]
> The SDK was rewritten in v4 and released in March 2026. Refer to the [v4 migration guide](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v3-to-v4) for instructions on updating your code.
> The SDK was rewritten in v4 and released in March 2026, and v5 was released in October 2026. Refer to the [v5 migration guide](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v4-to-v5) for instructions on updating your code.
>
> **This is the latest Langfuse Python SDK (v4, OpenTelemetry).** The legacy v2 client API (`trace()`, `span()`, `generation()`, `api.trace.list`) is **deprecated**. Do **not** use it for new instrumentation.
> **This is the latest Langfuse Python SDK (v5, OpenTelemetry).** The legacy v2 client API (`trace()`, `span()`, `generation()`, `api.trace.list`) is **deprecated**. Do **not** use it for new instrumentation.
>
> **Latest Python SDK (OpenTelemetry):** `pip install langfuse`. Use `get_client()` + `start_as_current_observation` / `@observe`. Prompts/datasets/scores: the same `langfuse` package. Docs: https://langfuse.com/docs/observability/sdk/overview. Upgrade: [v2 to v3](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v2-to-v3), [v3 to v4](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v3-to-v4).
> **Latest Python SDK (OpenTelemetry):** `pip install langfuse`. Use `get_client()` + `start_as_current_observation` / `@observe`. Prompts/datasets/scores: the same `langfuse` package. Docs: https://langfuse.com/docs/observability/sdk/overview. Upgrade: [v2 to v3](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v2-to-v3), [v3 to v4](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v3-to-v4), [v4 to v5](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v4-to-v5).
>
> Query traces with [Observations API v2](https://langfuse.com/docs/api-and-data-platform/features/observations-api) (`GET /api/public/v2/observations`, [API reference](https://api.reference.langfuse.com/#tag/observationsv2)), not `GET /api/public/traces` / `api.trace.list`.
>
Expand Down