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
poetry self add poetry-dotenv-plugin
poetry self add poetry-bumpversion
poetry install --all-extras
poetry run pre-commit install
- Add .env based on .env.example
- 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.
- Generate Fern Python SDK in langfuse and copy the files generated in
generated/pythoninto thelangfuse/apifolder in this repo. - Execute the linter by running
poetry run ruff format . - Rebuild and deploy the package to PyPi.
poetry version patchpoetry version prepatchfor pre-release versions
poetry installpoetry buildgit commit -am "chore: release v{version}"git pushgit tag v{version}git push --tagspoetry 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
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 langfuseYou need to have all extra dependencies installed to generate the reference.
poetry install --all-extras