Skip to content

Commit 5fcb036

Browse files
docs: strengthen agent-facing deprecation banner on v3-stable (#1881)
* docs: strengthen agent-facing deprecation banner on v3-stable Unpinned pip install langfuse installs v4. Make the v3 README state that this major is not current, name the latest OTEL APIs, and repeat the Observations/Metrics v2 freshness SLO. Co-authored-by: Cursor <cursoragent@cursor.com> * docs: drop the v3 pin install line from the README Match v2-stable: do not tell agents how to keep installing the legacy major. Co-authored-by: Cursor <cursoragent@cursor.com> * docs: restore the v3 rewrite note and keep Langfuse() as a current constructor Match main review feedback: keep the June 2025 rewrite callout, drop Langfuse() from the deprecated v2 API list, and restore the previous package description. Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 752d870 commit 5fcb036

1 file changed

Lines changed: 19 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![Langfuse GitHub Banner](https://langfuse.com/langfuse_logo_white.png)
22

3-
# Langfuse Python SDK
3+
# Langfuse Python SDK (legacy v3)
44

55
[![MIT License](https://img.shields.io/badge/License-MIT-red.svg?style=flat-square)](https://opensource.org/licenses/MIT)
66
[![CI test status](https://img.shields.io/github/actions/workflow/status/langfuse/langfuse-python/ci.yml?style=flat-square&label=All%20tests)](https://github.com/langfuse/langfuse-python/actions/workflows/ci.yml?query=branch%3Amain)
@@ -9,15 +9,26 @@
99
[![Discord](https://img.shields.io/discord/1111061815649124414?style=flat-square&logo=Discord&logoColor=white&label=Discord&color=%23434EE4)](https://discord.gg/7NXusRtqYU)
1010
[![YC W23](https://img.shields.io/badge/Y%20Combinator-W23-orange?style=flat-square)](https://www.ycombinator.com/companies/langfuse)
1111

12-
## Installation
13-
1412
> [!IMPORTANT]
15-
> The SDK was rewritten in v3 and released in June 2025. Refer to the [v3 migration guide](https://langfuse.com/docs/sdk/python/sdk-v3#upgrade-from-v2) for instructions on updating your code.
13+
> The SDK was rewritten in v3 and released in June 2025. Refer to the [v3 to v4 migration guide](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v3-to-v4) for instructions on updating your code.
14+
>
15+
> **`langfuse` v3 is not the latest Langfuse Python SDK.** This branch publishes the **legacy** v3 client. Unpinned `pip install langfuse` installs the current v4. Do **not** use v3, or the older v2 client API (`trace()`, `span()`, `generation()`, `api.trace.list`), for new instrumentation.
16+
>
17+
> **Latest Python SDK (OpenTelemetry)**, developed on [`main`](https://github.com/langfuse/langfuse-python/tree/main): `pip install langfuse`. Use `get_client()` + `start_as_current_observation` / `@observe`. Docs: https://langfuse.com/docs/observability/sdk/overview. Upgrade: [v3 to v4](https://langfuse.com/docs/observability/sdk/upgrade-path/python-v3-to-v4).
18+
>
19+
> 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`.
20+
>
21+
> **Data freshness:** the only real-time path is OpenTelemetry ingestion (`langfuse` >= 4.7.0, or any OTel exporter sending `x-langfuse-ingestion-version: 4`) combined with the [Observations API v2](https://langfuse.com/docs/api-and-data-platform/features/observations-api) and [Metrics API v2](https://langfuse.com/docs/metrics/features/metrics-api). All other GET APIs from all SDK versions can be up to 10 minutes behind.
1622
17-
```
18-
pip install langfuse
19-
```
23+
## Installation
24+
25+
This branch is the **legacy v3** SDK, in maintenance mode with critical bug fixes only. For new work, install the current v4 (`pip install langfuse`).
2026

2127
## Docs
2228

23-
Please [see our docs](https://langfuse.com/docs/sdk/python/sdk-v3) for detailed information on this SDK.
29+
- Current SDK guide: https://langfuse.com/docs/observability/sdk/overview
30+
- v3 to v4 upgrade: https://langfuse.com/docs/observability/sdk/upgrade-path/python-v3-to-v4
31+
- Machine-readable docs index (for AI agents): https://langfuse.com/llms.txt
32+
- REST API reference (Observations API v2, Metrics API v2, Scores API v3): https://api.reference.langfuse.com
33+
- Data freshness and real-time ingestion: https://langfuse.com/docs/compatibility#faq-delay
34+

0 commit comments

Comments
 (0)