Skip to main content

Python SDK for the Everest API

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

log10_everest_sdk-0.1.0.tar.gz (161.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

log10_everest_sdk-0.1.0-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

Details for the file log10_everest_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: log10_everest_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 161.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for log10_everest_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a9a616b48f1e9e734e6e542f8e34ea4244252da550ccb01340aff0124a323b9f
MD5 dd0c28032f7b9f8084e9146fd388d054
BLAKE2b-256 fbe24ff9ab3bbf9f5c19851cbea378160e9f5ddca1c82d55879a2a582f73caf3

See more details on using hashes here.

File details

Details for the file log10_everest_sdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: log10_everest_sdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 13.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for log10_everest_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2e2861400e7c13faa074c3e9fada43f98b0e6737f00a99adabbffdce371cd28
MD5 c07a5afc65a81ad701e4fca2cf56ce6d
BLAKE2b-256 1c67b31efaeb8d84f800b98b7241c6aa136fd28ed7fffbc1e6e919e4dd421736

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page