Skip to content

Upassist Python SDK

Welcome to the official documentation for the Upassist Cloud Python SDK. This SDK provides a simple and intuitive way to interact with the Upassist Cloud API.

Features

  • Heartbeat Monitoring: Create and manage heartbeat monitors for your applications
  • Log Management: Collect and manage application logs
  • API Clients: Both synchronous and asynchronous API clients available
  • Type Safety: Built with Pydantic for robust type checking and validation

Quick Start

import upassist

# Configure your API key
upassist.config.API_KEY = 'your-api-key'

# Create a heartbeat instance
heartbeat = upassist.Heartbeat("your-heartbeat-slug")

# Send a heartbeat event
heartbeat.event()

Installation

pip install upassist

For development dependencies:

pip install upassist[docs]

Documentation Structure