Skip to main content

Lightweight task progress tracking with pluggable storage backends

Project description

progressorx

progressor — lightweight progress-tracking package for long-running tasks.

Features:

  • report_progress(task_id, progress=None, increase=None) — set or increment progress (0..100).
  • get_progress(task_id) — get current progress and status.
  • Pluggable backends: InMemory, Redis, SQLAlchemy (SQLite/Postgres).
  • Thread/process/distributed safe when using a proper backend (Redis/SQL).

Quick example

from progressorx import ProgressManager
from progressorx.backends.memory import InMemoryStore

store = InMemoryStore()
mgr = ProgressManager(store)

# create task
mgr.create('task-1')

# set and increment progress
mgr.report_progress('task-1', progress=10)
mgr.report_progress('task-1', increase=5)

rec = mgr.get_progress('task-1')
print(rec.task_id, rec.progress, rec.status)  # task-1 15.0 in_progress

Examples

  • Basic runnable example: src/progressorx/examples/basic.py
    • Run: python -m progressorx.examples.basic
  • FastAPI integration: src/progressorx/examples/fastapi.py
    • Run: uvicorn progressorx.examples.fastapi:app --reload

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

progressorx-0.0.8.tar.gz (43.6 kB view details)

Uploaded Source

Built Distribution

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

progressorx-0.0.8-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file progressorx-0.0.8.tar.gz.

File metadata

  • Download URL: progressorx-0.0.8.tar.gz
  • Upload date:
  • Size: 43.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for progressorx-0.0.8.tar.gz
Algorithm Hash digest
SHA256 fcb2c2abd68cae291f8a569c526c3c588c82cc69a9a1191275a09c86e9c4172b
MD5 2c62a3fab6c59ad63f0dddde3f87a0a3
BLAKE2b-256 347b925306a006fb630857fe8ec3f75ff33db90e9a4dfd46a080e43df3b02203

See more details on using hashes here.

File details

Details for the file progressorx-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: progressorx-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for progressorx-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 9adfedd9a3b3b8429c6e5743ed9674ded08cb262d14ec083ea672cb3bbcd8c26
MD5 9f31f654f7cc46c62c5cd3886a9a70c2
BLAKE2b-256 83e544e166dda26d5606baa08033d5dad504373fe1c63010d5c04b65a5def77c

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