django-tqdm

Fast, Extensible Progress Meter (tqdm) For Django.

Use tqdm in Django management commands seamlessly.
It provides simple universal commands for Django management command to output
text using standard command functions and tqdm.
Only currently supported versions of Django and Python are supported.

Usage

from django_tqdm import BaseCommand
from time import sleep

class Command(BaseCommand):
    def handle(self, *args, **options):
        # Output directly
        self.error("Error")
        self.info("Info")

        # Output through tqdm
        t = self.tqdm(total=50)
        for x in range(50):
            sleep(0.03)
            t.update(1)

            if x == 10:
                t.info("X = 10")
            if x == 20:
                t.error("X = 20")

Advanced:

info(text, ending="\n", fatal=False)
error(text, ending="\n", fatal=False)
write(text, ending="\n", fatal=False, error=False)

If you set fatal to True it will terminate the command after printing the message.

For documentation on tqdm see tqdm.

Comparison

In django-tqdm:

self.info("info")
self.error("error")

In vanilla Django:

self.stdout.write("info")
self.stderr.write("error")

Demos

Demo 1 - Simple usage

self.info("info")
self.error("error")

Demo 2 - tqdm usage

t = self.tqdm(total=50)
for x in range(50):
    sleep(0.02)
    t.update(1)
    if x == 10:
        t.info("info")
    if x == 40:
        t.error("error")

Demo 3 - Vanilla tqdm with default settings for comparison

t = tqdm(total=50)
for x in range(50):
    sleep(0.02)
    t.update(1)
    if x == 25:
        t.write("info")
    if x == 40:
        t.write("error", file=sys.stderr)

Developer documentation

Read developer documentation.

Metadata

Release files for django-tqdm 1.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for django-tqdm 1.3.1
File	Interpreter	ABI	Platform	Reset
django_tqdm-1.3.1-py3-none-any.whl 6.1 kB Jun 19, 2022	Python 3	none	any	Details

Release files / django_tqdm-1.3.1-py3-none-any.whl

Download URL	django_tqdm-1.3.1-py3-none-any.whl
Size	6.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`571a68d50050667d6b8e0c1f284542d372801a0ac3e3e9f817f1b854e043c3f4`
BLAKE2b-256 checksum How to use checksums	`a9ef84d90cc6b5c328475398fbf312c601902445218e02010ad912d48d365227`
Upload date	Jun 19, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.8.10`