Skip to content

tcbegley/tqdm-countdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tqdm-countdown

Have you ever been monitoring the progress of your code but felt like there just wasn't enough drama? Well, tqdm-countdown is here to help! It creates a tqdm progress bar that plays the countdown music from the British game show Countdown when there is 30 seconds or less left to go on your progress bar. Cheer on your code as it races to complete its task before the time runs out, all to the soundtrack of the tensest game show music on television!

Installation

It's as easy as

pip install git+https://github.com/tcbegley/tqdm-countdown.git

Example

The interface is the same as tqdm.

import time

from tqdm_countdown import tqdm

for i in tqdm(range(65)):
    time.sleep(0.5)

Or try it in a notebook

import time

from tqdm_countdown.notebook import tqdm

for i in tqdm(range(65)):
    time.sleep(0.5)

You can even let tqdm_countdown figure out whether it is being used in a script or a notebook.

from tqdm_countdown.autonotebook import tqdm

FAQ

Q: Can this be used as a drop-in replacement for tqdm?

Sure! As long as you don't want to use one of the features of tqdm that I haven't implemented.

Q: Is there a performance penalty to using this over tqdm?

Probably? But it's way more fun, and since time flies when you're having fun your code might feel faster.

Q: How stable is this?

I've tested it on both of the examples above and it was fine.

Q: Hold on... isn't it possible the music ends at the wrong time if the time taken per iteration is not fixed?

PRs welcome smartypants.

About

tqdm progress bars, but more exciting!

Resources

Stars

Watchers

Forks

Languages