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.1.0.tar.gz (45.2 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.1.0-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for progressorx-0.1.0.tar.gz
Algorithm Hash digest
SHA256 28f6219a3703fd79a14354788ec359791135ba95760278ee097c83fd27573fb6
MD5 303e251d8c28df44abcf41f67e9ccbc8
BLAKE2b-256 87d0b70cc978c98d8495b73de09227796706ce160aadc0649db97023ed8c87af

See more details on using hashes here.

File details

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

File metadata

  • Download URL: progressorx-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.5 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ce12a574fe0286d4d5456ccbe3be580bee80eb74643d995651cd34ab3ec7bf22
MD5 f548021b0ba841de46c74b5cf16db819
BLAKE2b-256 92a6fa3703a319663c5eacf801c18d879a57370df2312daeab312937edb26b57

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