pyloops 1.6.1.4

Unofficial Python SDK for Loops.so email platform

PyLoops

Unofficial Python SDK for Loops.so.

Installation

pip install pyloops

Or with uv:

uv add pyloops

Quick Start

PyLoops offers two ways to interact with the Loops API:

High-Level API

import pyloops

# Configure once (or set LOOPS_API_KEY environment variable)
pyloops.configure(api_key="your_api_key_here")

# Get the client
client = pyloops.get_client()

# Upsert a contact
await client.upsert_contact(
    email="[e-mail]",
    first_name="John",
    last_name="Doe",
    subscribed=True,
)

# Find a contact
contacts = await client.find_contact(email="[e-mail]")

# Send an event
await client.send_event(
    event_name="user_signup",
    email="[e-mail]",
    event_properties={"plan": "premium"},
)

# List mailing lists
mailing_lists = await client.list_mailing_lists()

Low-Level API

For more control, use the auto-generated low-level API directly:

from pyloops import AuthenticatedClient
from pyloops.api.contacts import put_contacts_update
from pyloops.models import ContactUpdateRequest

client = AuthenticatedClient(
    base_url="https://app.loops.so/api/v1",
    token="your_api_key_here",
)

response = await put_contacts_update.asyncio(
    client=client,
    body=ContactUpdateRequest(
        email="[e-mail]",
        first_name="John",
        last_name="Doe"
    )
)

Authentication

All API calls require a Loops API key. Get your API key from your Loops account settings.

There are three ways to configure authentication:

1. Environment variable:

export LOOPS_API_KEY="your_api_key_here"

2. Module-level configuration:

import pyloops
pyloops.configure(api_key="your_api_key_here")

3. Per-client configuration:

import pyloops
client = pyloops.LoopsClient(api_key="your_api_key_here")

Features

This SDK provides access to all Loops.so API endpoints:

• Contacts: Create, update, find, and delete contacts
• Contact Properties: Manage custom contact properties
• Mailing Lists: View available mailing lists
• Events: Trigger event-based emails
• Transactional Emails: Send and list transactional emails
• Sending IPs: Retrieve dedicated sending IP addresses

Documentation

For detailed API documentation, visit the Loops.so API docs.

Automated Updates

This SDK is automatically updated to match the latest Loops.so API specification. The package version corresponds to the Loops API version (current: 1.6.1).

A GitHub Action checks for API updates daily and creates a pull request when changes are detected. After review and merge, a new version is automatically published to PyPI.

Development

Setup

# Clone the repository
git clone https://github.com/doctorgpt-corp/pyloops.git
cd pyloops

# Install dependencies with uv
uv sync --all-groups

Running Tests

Using just:

just check      # Run linting + type checking
just lint       # Run linting only
just typecheck  # Run type checking only
just fmt        # Format code

Or directly with uv:

uv run ruff check src/
uv run pyright src/

Project Structure

src/pyloops/
├── __init__.py          # Main exports
├── client.py            # High-level LoopsClient wrapper
├── config.py            # Configuration
├── exceptions.py        # Exceptions
├── api/                 # Re-exports from _generated.api
├── models/              # Re-exports from _generated.models
└── _generated/          # ALL auto-generated code
    ├── client.py
    ├── api/
    ├── models/
    └── types.py

Regenerate SDK

To manually regenerate the SDK from the latest OpenAPI spec:

just generate

Or manually:

rm -rf src/pyloops/_generated
uv tool run openapi-python-client generate --url https://app.loops.so/openapi.yaml --meta uv
mv loops-open-api-spec-client/loops_open_api_spec_client src/pyloops/_generated
rm -rf loops-open-api-spec-client openapi.yaml

Custom code is never touched during regeneration.

License

MIT

Disclaimer

This is an unofficial SDK and is not affiliated with or endorsed by Loops.so.