everest-sdk

Python SDK for the Everest API.

Installation

uv pip install log10-everest-sdk
# or
pip install log10-everest-sdk

Quick start

Set your credentials as environment variables:

export EVEREST_API_KEY="sk_live_..."
export EVEREST_WORKSPACE_ID="ws_..."

import asyncio
from pathlib import Path

from everest_sdk import EverestClient

# Reads EVEREST_API_KEY and EVEREST_WORKSPACE_ID from env
client = EverestClient()

async def main():
    await client.validate_credentials()

    # List files
    files = await client.files.list()

    # Upload a file
    docs = await client.files.upload([Path("report.pdf")])

    # Download a file
    content = await client.files.download(docs[0].id)

    # List reports
    reports = await client.reports.list()

    # Download latest report as PDF
    pdf = await client.reports.download_latest("Q4 Report", format="pdf")
    Path("report.pdf").write_bytes(pdf)

asyncio.run(main())

Getting started script

The scripts/getting_started.py script walks through the full workflow interactively: upload a file, create a template and generate a report in the platform, then download the result as DOCX.

Setup

# Create a virtual environment and install the SDK with script dependencies
uv venv
uv pip install -e ".[scripts]"

Create a .env.local file with your credentials:

# .env.local
EVEREST_API_KEY=sk_live_...
EVEREST_WORKSPACE_ID=<your-workspace-id>

Run

Place a source-data.pdf in the current directory, then:

uv run scripts/getting_started.py

The script loads .env.local automatically. It will pause at each platform step (template creation, report generation) and wait for you to type yes before continuing.