Repository files navigation

Please see thePython integration docs for details.

We recommend usinguv. It's super fast.

1. Runuv venv env (creates virtual environment called "env")
   • orpython3 -m venv env
2. Runsource env/bin/activate (activates the virtual environment)
3. Runuv sync --extra dev --extra test (installs the package in develop mode, along with test dependencies)
   • orpip install -e ".[dev,test]"
4. you have to runpre-commit install to have auto linting pre commit
5. Runmake test
6. To run a specific test dopytest -k test_no_api_key

uv python install 3.9.19uv python pin 3.9.19uv venvsource env/bin/activateuv sync --extra dev --extratestpre-commit installmaketest

Assuming you have alocal version of PostHog running, you can runpython3 example.py to see the library in action.

Updates are released automatically using GitHub Actions whenversion.py is updated onmaster. After bumpingversion.py inmaster and adding toCHANGELOG.md, therelease workflow will automatically trigger and deploy the new version.

If you need to check the latest runs or manually trigger a release, you can go toour release workflow's page and dispatch it manually, using workflow frommaster.

You can runmake prep_local, and it'll create a new folder alongside the SDK repo one calledposthog-python-local, which you can then import into the posthog project by changing pyproject.toml to look like this:

dependencies = [..."posthoganalytics"#NOTE: no version number...]...[tools.uv.sources]posthoganalytics = {path ="../posthog-python-local" }

This'll let you build and test SDK changes fully locally, incorporating them into your local posthog app stack. It mainly takes care of theposthog -> posthoganalytics module renaming. You'll need to re-runmake prep_local each time you make a change, and re-runuv sync --active in the posthog app project.