Skip to content

Commit d0806f3

Browse files
authored
docs: update readme and reference (#1260)
1 parent 968ef49 commit d0806f3

File tree

3 files changed

+18
-23
lines changed

3 files changed

+18
-23
lines changed

README.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![GitHub Banner](https://github.com/langfuse/langfuse-python/assets/2834609/3c36488e-6fe6-4a82-b0f5-5419250ddf86)
1+
![Langfuse GitHub Banner](https://langfuse.com/langfuse_logo_white.png)
22

33
# Langfuse Python SDK
44

@@ -12,28 +12,12 @@
1212
## Installation
1313

1414
> [!IMPORTANT]
15-
> The SDK was rewritten in v2 and released on December 17, 2023. Refer to the [v2 migration guide](https://langfuse.com/docs/sdk/python/low-level-sdk#upgrading-from-v1xx-to-v2xx) for instructions on updating your code.
15+
> The SDK was rewritten in v3 and released on December 17, 2023. Refer to the [v3 migration guide](https://langfuse.com/docs/sdk/python/sdk-v3#upgrade-from-v2) for instructions on updating your code.
1616
1717
```
1818
pip install langfuse
1919
```
2020

2121
## Docs
2222

23-
- Decorators: https://langfuse.com/docs/sdk/python/decorators
24-
- Low-level SDK: https://langfuse.com/docs/sdk/python/low-level-sdk
25-
- Langchain integration: https://langfuse.com/docs/integrations/langchain/tracing
26-
27-
## Interfaces
28-
29-
Interfaces:
30-
31-
- `@observe()` decorator ([docs](https://langfuse.com/docs/sdk/python/decorators))
32-
- Low-level tracing SDK ([docs](https://langfuse.com/docs/sdk/python/low-level-sdk))
33-
- Wrapper of Langfuse public API
34-
35-
Integrations
36-
37-
- OpenAI SDK ([docs](https://langfuse.com/docs/integrations/openai))
38-
- LlamaIndex ([docs](https://langfuse.com/docs/integrations/llama-index))
39-
- LangChain ([docs](https://langfuse.com/docs/integrations/langchain))
23+
Please [see our docs](https://langfuse.com/docs/sdk/python/sdk-v3) for detailed information on this SDK.

langfuse/__init__.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
""".. include:: ../README.md"""
22

3-
from ._client.attributes import LangfuseOtelSpanAttributes # noqa
43
from ._client.client import Langfuse # noqa
54
from ._client.get_client import get_client # noqa
65
from ._client.observe import observe # noqa
76
from .version import __version__ # noqa
7+
from ._client.span import LangfuseSpan, LangfuseGeneration, LangfuseEvent
8+
from ._client.attributes import LangfuseOtelSpanAttributes
9+
10+
__all__ = [
11+
"Langfuse",
12+
"get_client",
13+
"observe",
14+
"LangfuseSpan",
15+
"LangfuseGeneration",
16+
"LangfuseEvent",
17+
"LangfuseOtelSpanAttributes",
18+
]

poetry.lock

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)