Skip to main content

Lightweight task progress tracking with pluggable storage backends

Project description

progressor

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 progressor import ProgressManager
from progressor.backends.memory import InMemoryStore


store = InMemoryStore()
mgr = ProgressManager(store)


mgr.report_progress('task-1', progress=10)
mgr.report_progress('task-1', increase=5)
print(mgr.get_progress('task-1')) # {'task_id': 'task-1', 'progress': 15, 'status': 'in_progress'}

See examples/fastapi_example.py for how to integrate with FastAPI.

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.1.tar.gz (41.8 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.1-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: progressorx-0.0.1.tar.gz
  • Upload date:
  • Size: 41.8 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.1.tar.gz
Algorithm Hash digest
SHA256 1058cce532c1727d329d863ef7d7e36cac1ca7309cd82f8118735318a4197883
MD5 0f2a88f8ba7ba12806b9a78181638485
BLAKE2b-256 4604c508807381a0bfa0933467a49130fb71e8ee90d27967684d149ff3c56531

See more details on using hashes here.

File details

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

File metadata

  • Download URL: progressorx-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.0 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7bcf793f1522171b8e22fadf5e4339b7781ea341969a72d02cd841568b550fbd
MD5 e2ef227693463ea6c23c8395302d4d54
BLAKE2b-256 06caec2920daeda305486942d229ebd5fe4112468acabb5af3e8527e94ae096a

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