Skip to main content

Things SDK

things-sdk on PyPI CI

Reusable Python SDK for Things Cloud sync.

Looking for the HTTP service instead of the Python library? See the root README.md for things-api.

Changelog — For a detailed history of changes, see CHANGELOG.md.

When should I use this?

Use things-sdk when you want to build Python-native tooling on top of Things Cloud, such as:

  • CLI tools
  • automation scripts
  • background workers
  • MCP servers
  • custom internal integrations

If you want a ready-made HTTP/HTTPS service instead, use things-api from the repository root.

Installation

pip install things-sdk

Quick Start

import asyncio
from things_sdk import (
    ThingsClient,
    TaskService,
    DefaultSyncConfig,
    configure_sync,
    create_engine_and_session,
    init_db,
    pull_sync,
    push_sync,
)

async def main():
    # 1. Database setup
    engine, session_factory = create_engine_and_session(
        "sqlite+aiosqlite:///data/things.db"
    )
    await init_db(engine)

    # 2. Configure sync engine (use built-in defaults or pass your own config)
    configure_sync(DefaultSyncConfig())

    # 3. Sync from Things Cloud
    client = ThingsClient(email="you@example.com", password="your-password")
    async with session_factory() as session:
        result = await pull_sync(client, session)
        print(f"Pulled: {result}")
    await client.close()

    # 4. Query tasks
    svc = TaskService()
    async with session_factory() as session:
        tasks = await svc.list_tasks(session)
        for t in tasks:
            print(f"  - {t['title']} ({t['status']})")

    await engine.dispose()


asyncio.run(main())

What's included

Module Description
ThingsClient Async HTTP client for Things Cloud
pull_sync / push_sync Sync engine with retry + circuit breaker
TaskService CRUD operations for tasks, areas, tags
create_engine_and_session SQLAlchemy async engine factory
Domain models Task, Area, Tag, ChecklistItem, SyncState
CloudClientProtocol Protocol for custom client implementations
SyncConfig Protocol for sync configuration
EntityHandler Strategy pattern for extending sync to new entity types

Examples

See the examples/sdk/ directory for runnable examples:

Example Description
list_tasks.py Sync from Things Cloud, then print all pending tasks
sync_once.py Run a single pull + push sync cycle
create_task.py Create a task locally and push it to Things Cloud

All examples use the public things_sdk API:

THINGS_EMAIL=you@example.com THINGS_PASSWORD=secret uv run examples/sdk/list_tasks.py

Smoke-tested release artifacts

Releases validate that the SDK is not just built, but actually installable and usable:

  • build wheel + sdist
  • install wheel into a clean virtualenv
  • import things_sdk
  • create a SQLAlchemy engine/session factory
  • after publish, install things-sdk==<version> from PyPI and repeat the basic checks

That means a published things-sdk release has already passed both a build-time smoke test and a post-publish verification in CI.

Metadata

Release files for things-sdk 0.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for things-sdk 0.3.3
File Size Uploaded
things_sdk-0.3.3.tar.gz 21.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for things-sdk 0.3.3
File Interpreter ABI Platform
things_sdk-0.3.3-py3-none-any.whl Python 3 none any Details

Total release size: 45.8 kB

Release files / things_sdk-0.3.3.tar.gz

Download URL things_sdk-0.3.3.tar.gz
Size 21.3 kB
Tags Source
SHA-256 checksum
How to use checksums
187944bed2e605bc5d8ba9b34fe7c5328939cdb5410dc784d12d49dca0c8a8ad
BLAKE2b-256 checksum
How to use checksums
0a7de4e11438645d7def1ae08e3c7431ca92e50e0a1c5f1a748dbcd156bdb52e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 28, 2026.

Transparency log

Release files / things_sdk-0.3.3-py3-none-any.whl

Download URL things_sdk-0.3.3-py3-none-any.whl
Size 24.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
917cc5f271b01951fbd9a3a512ad39cfa11db2bc2936702dc4b822a6577451b5
BLAKE2b-256 checksum
How to use checksums
635dc1a54792aaef8568a57e533597580ff4ca3e8e16546b7be4f0073d7ee443
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 28, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.3.3 This release

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page