django-tqdm

Fast, Extensible Progress Meter (tqdm) For Django.

Use tqdm in django management commands seamlessly. It uses tqdm and it is meant to be used with Django. It provides simple universal commands for Django management command to output text using standard command functions and tqdm.

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)

Metadata

Release files for django-tqdm 0.0.1

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

Source distribution (sdist)

Source distribution for django-tqdm 0.0.1
File	Size	Uploaded
django_tqdm-0.0.1.tar.gz	3.4 kB	Apr 23, 2017	Details

Release files / django_tqdm-0.0.1.tar.gz

Download URL	django_tqdm-0.0.1.tar.gz
Size	3.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`8759126aef65b6b592b5343697efe38d58d4afd6e5add2383266c0d9a6f883fc`
BLAKE2b-256 checksum How to use checksums	`b5cdc986414401c931810ebcf72b4cb6ba2d67400252f4252dc2b538c2b56145`
Upload date	Apr 23, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No