Installation

Package Managers

Using uv (Fastest)

# Basic installation
uv add lumberjack_sdk

# With local development server
uv add 'lumberjack_sdk[local-server]'

# With specific framework support
uv add 'lumberjack_sdk[local-server,flask]'
uv add 'lumberjack_sdk[local-server,fastapi]'
uv add 'lumberjack_sdk[local-server,django]'

Using pip

# Basic installation
pip install lumberjack_sdk

# With local development server
pip install 'lumberjack_sdk[local-server]'

# With specific framework support
pip install 'lumberjack_sdk[local-server,flask]'
pip install 'lumberjack_sdk[local-server,fastapi]'
pip install 'lumberjack_sdk[local-server,django]'

Using Poetry

# Basic installation
poetry add lumberjack_sdk

# With extras
poetry add 'lumberjack_sdk[local-server]'
poetry add 'lumberjack_sdk[local-server,flask]'

Installation Extras

Extra	Description	Dependencies
`local-server`	Local development server with web UI	FastAPI, Uvicorn, WebSockets
`flask`	Flask framework integration	Flask instrumentor
`fastapi`	FastAPI framework integration	FastAPI instrumentor
`django`	Django framework integration	Django instrumentor

System Requirements

Python: 3.10 or higher

Verifying Installation

After installation, verify everything is working:

# Check version
python -c "import lumberjack_sdk; print(lumberjack_sdk.__version__)"

# Test CLI tools (if local-server installed)
uv run lumberjack --help
# or lumberjack --help if installed with pip

# Start local server
uv run lumberjack serve
r lumberjack serve if installed with pip

Development vs Production

Development Setup

For local development, install with the local-server extra:

uv add 'lumberjack_sdk[local-server]'

This includes:

Local web UI for viewing logs
MCP server for Claude/Cursor integration
Development utilities

Production Setup

Troubleshooting

Import Errors

If you get import errors:

# Reinstall with all dependencies
pip install --upgrade --force-reinstall 'lumberjack_sdk[local-server]'

Permission Errors

UV manages your venv for you, but if not using uv, consider a venv:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install lumberjack_sdk

Version Conflicts

If you have version conflicts with dependencies:

# Check for conflicts
pip check

# Upgrade pip and setuptools
pip install --upgrade pip setuptools

# Then reinstall
pip install --upgrade lumberjack_sdk

Next Steps

Quick Start - Get up and running quickly
Configuration - Configure for your environment
Claude Integration - Set up AI debugging