A client library for accessing langfuse
Project description
Langfuse Python SDK
Installation
[!IMPORTANT] The SDK was rewritten in v2 and released on December 17, 2023. Refer to the v2 migration guide for instructions on updating your code.
pip install langfuse
Full documentation: https://docs.langfuse.com/sdk/python
Langchain documentation: https://docs.langfuse.com/langchain
Development
Add Poetry plugins
poetry self add poetry-dotenv-plugin
poetry self add poetry-bumpversion
Install dependencies
poetry install --all-extras
Add Pre-commit
poetry run pre-commit install
Tests
Setup
- Add .env based on .env.example
Run
- Run all
poetry run pytest -s -v --log-cli-level=INFO
- Run a specific test
poetry run pytest -s -v --log-cli-level=INFO tests/test_core_sdk.py::test_flush
- E2E tests involving OpenAI and Serp API are usually skipped, remove skip decorators in tests/test_langchain.py to run them.
Update openapi spec
- Generate Fern Python SDK in langfuse and copy the files generated in
generated/python
into thelangfuse/api
folder in this repo. - Execute the linter by running
poetry run ruff format .
- Rebuild and deploy the package to PyPi.
Publish release
poetry version patch
poetry version prepatch
for pre-release versions
poetry install
poetry build
git commit -am "chore: release v{version}"
git push
git tag v{version}
git push --tags
poetry publish
- Create PyPi API token: https://pypi.org/manage/account/token/
- Setup:
poetry config pypi-token.pypi your-api-token
- Create a release on GitHub with the changelog
SDK Reference
Note: The generated SDK reference is currently work in progress.
The SDK reference is generated via pdoc. To update the reference, run the following command:
poetry run pdoc -o docs/ --docformat google langfuse
You need to have all extra dependencies installed to generate the reference.
poetry install --all-extras
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
langfuse-2.20.1.tar.gz
(61.2 kB
view hashes)
Built Distribution
langfuse-2.20.1-py3-none-any.whl
(124.6 kB
view hashes)
Close
Hashes for langfuse-2.20.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 784b47faea6fae1a2e0b3507b8c4904ce313d905a09bea64b0795a3a71a5c692 |
|
MD5 | d2cc04addefb27db2e62a8fafe16c637 |
|
BLAKE2b-256 | b5e1bfd6b510db78f3a659711a9d6c4ad85accef5ac7c35da9f373b9f3feabb5 |