Skip to main content

ProgressDB backend Python SDK

Project description

ProgressDB Python SDK (backend)

Lightweight Python SDK for backend callers of ProgressDB. Designed for server-side use (holds backend/admin API keys).

Install (when published):

pip install progressdb

Quickstart

from progressdb import ProgressDBClient

client = ProgressDBClient(base_url='https://api.example.com', api_key='ADMIN_KEY')

# Sign a user id (backend-only)
sig = client.sign_user('user-123')

# Create a thread
thread = client.create_thread({'title': 'General'})

# Create a message
msg = client.create_message({'thread': thread['id'], 'body': {'text': 'hello'}})

Features

  • sign_user(user_id) — calls POST /v1/_sign (backend-only)
  • admin_health(), admin_stats() — admin endpoints -- Thread and message helpers: list_threads(author=None, title=None, slug=None), create_thread, create_message, delete_thread, etc.

Note: list_threads accepts optional query filters author, title, and slug. Backend callers should provide author (either via this parameter or the X-User-ID header) when using backend/admin keys because the server requires an author to be resolved for this endpoint.

Thread helpers (notes)

  • get_thread(id, author=None) — retrieve thread metadata (title, slug, author, timestamps). Backend callers should provide author when using backend/admin keys (either via this parameter or by setting X-User-ID header) because the server requires author resolution for this endpoint.

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

progressdb-0.1.4.tar.gz (3.0 kB view details)

Uploaded Source

Built Distribution

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

progressdb-0.1.4-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

Details for the file progressdb-0.1.4.tar.gz.

File metadata

  • Download URL: progressdb-0.1.4.tar.gz
  • Upload date:
  • Size: 3.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.1

File hashes

Hashes for progressdb-0.1.4.tar.gz
Algorithm Hash digest
SHA256 071df4910103cee7109746c1762cd84012ff65a59c35664c5262f6395ab19c39
MD5 40080c1c50204e9ff059537bfd835c6d
BLAKE2b-256 62462e82923087e019b1c6bef816296661aa895706ab34a05eb441929f88e056

See more details on using hashes here.

File details

Details for the file progressdb-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: progressdb-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 3.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.1

File hashes

Hashes for progressdb-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8bdb441efe7b5d2b3fbb8c9431b1bf85daa4870f33397dbd35479db35379faea
MD5 a350a520bcbfa13a3c0cecc6e6fe310d
BLAKE2b-256 37e1dd94f6021dd9acb28689a5c0401b1dcf2df7eff2753ae47e978a11a92395

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