Skip to main content

ProgressDB Python SDK - Unified frontend and backend support

Project description

@progressdb/python

Python SDK for backend callers of ProgressDB. Uses backend API keys to call frontend routes without signature requirements.

Installation

pip install progressdb

Quick Start

from progressdb import ProgressDB
db = ProgressDB({ 
    'baseUrl': 'https://api.example.com', 
    'apiKey': 'your-backend-key'
})

db.create_thread({'title': 'General'}, 'user-123')

API

Client

ProgressDB(options: SDKOptionsType)

Messages

  • list_thread_messages(thread_key, query, user_id) - List messages in thread
  • create_thread_message(thread_key, message, user_id) - Create message
  • get_thread_message(thread_key, message_key, user_id) - Get message
  • update_thread_message(thread_key, message_key, message, user_id) - Update message
  • delete_thread_message(thread_key, message_key, user_id) - Delete message

Threads

  • create_thread(thread, user_id) - Create thread
  • list_threads(query, user_id) - List threads
  • get_thread(thread_key, user_id) - Get thread
  • update_thread(thread_key, thread, user_id) - Update thread
  • delete_thread(thread_key, user_id) - Delete thread

Health

  • healthz() - Basic health check
  • readyz() - Readiness check with version

Signature

  • sign_user(user_id) - Generate signature for user

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.2.0.tar.gz (7.5 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.2.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: progressdb-0.2.0.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for progressdb-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f5a0fb76c0a428c75d68aae761714c6a57d5474fb7206fab4710d1572a646dff
MD5 57ba454412a72683cc60acefff39a370
BLAKE2b-256 86462368fd27cebb8945ef1a85936510bdc980c12ceee25c74d5b21f756ecd9c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: progressdb-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for progressdb-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 17db044342d85561f3de4276420f68cbfc630e251d4df1f3408bcc562d47fad0
MD5 46885960879221a8dccf9fac451494c4
BLAKE2b-256 44bb9b72a14ec9952dc2d946787e7e767bcfa61dda2713021bf0f5aa18870a76

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