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.

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.3.tar.gz (2.8 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.3-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: progressdb-0.1.3.tar.gz
  • Upload date:
  • Size: 2.8 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.3.tar.gz
Algorithm Hash digest
SHA256 4ea5ca07bcc51892d82684ffad7cf5aad6c1c48005cd42c1ccf7aa64ad038220
MD5 6b872d2ae4e5942048ae416ac595e975
BLAKE2b-256 569756cee8f1dd4b5f2f704fc3b647899eaabc595ea2588216efb7890d71c97b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: progressdb-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 3.2 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 24675a20bdb4e506b666ec2e46bdd19f97f0af10ca5173eb0449ba4baa02d1cb
MD5 6ff5303be3200cc24c13f06536dee591
BLAKE2b-256 858dd4e32386ea26444d33c80484fc7c55d7f2883a938f7ddee58f7adce2f70b

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