Skip to main content

A sleek tool that displays visually appealing progress bars and draws metric based curves in real-time.

Project description

tcurve-icon.png

TCurve

A sleek progress bar tool
For better experience of printing on the terminal.

Version GitHub Repo Stars Python MIT License


🚀 Spotlight

📈 Fascinating Dashboard

It shows visually appealing progress bars and draws metric based curves in real-time.

THAIh9.gif


⚡ Quick Start

You can simply take it as a wrapper or help you plot curves.

from tcurve import Dash as tcd
from time import sleep

# a simple wrapper
for i in tcd(range(10)):
    time.sleep(0.5)

# wrap a generator
for i in tcd(enumerate(range(30))):
    time.sleep(0.3)

# with keyword arguments
for i,n in tcd(enumerate(range(30)), format={'number': [lambda x:x[1], CUSTOM]}, epoch=2, mpe=30, stage='COUNT', interv=1, wipe=False):
    time.sleep(0.3)

# in a complicated manner
dash = tcd(format={'Acc': ['.1f', PERCENT]})
unit_acc = [0.012, 0.045, 0.134, 0.189, 0.234, 0.278, 0.345, 0.378, 0.456, 0.423, 0.51, 0.599, 0.623, 0.62, 0.7] # create a fake array for this tutorial
fake_acc = unit_acc + unit_acc[::-1] + unit_acc + unit_acc[::-1] + unit_acc + unit_acc[::-1]
for i, a in enumerate(fake_acc):
    time.sleep(0.1)
    dash({'Accuracy': a}, 0, i, len(fake_acc))

🔥 Dive Deeper

Let's take the last example in previous part to show how could you use more arguments for delicate control.

# below is the common setting
unit_acc = [0.012, 0.045, 0.134, 0.189, 0.234, 0.278, 0.345, 0.378, 0.456, 0.423, 0.51, 0.599, 0.623, 0.62, 0.7] # create a fake array for this tutorial
flat_acc = [0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5]
fake_acc = 10 * (unit_acc + unit_acc[::-1] + flat_acc)

We only take this for-loop to demonstrate. First, you can use is_global=True to plot the entire curve.

dash = tcd(format={'Acc': ['.1f', PERCENT]})
for i, a in enumerate(fake_acc):
    time.sleep(0.1)
    dash({'Accuracy': a}, 0, i, len(fake_acc), is_global=True)

Make is_elastic=True to dynamically stretch or squeeze the vertical axis.

dash = tcd(format={'Acc': ['.1f', PERCENT]})
for i, a in enumerate(fake_acc):
    time.sleep(0.1)
    dash({'Accuracy': a}, 0, i, len(fake_acc), is_global=False)

Make is_elastic=True to dynamically stretch or squeeze the vertical axis so that the fluctuation of curves is prominent enough to be observed.

dash = tcd(format={'Acc': ['.1f', PERCENT]})
for i, a in enumerate(fake_acc):
    time.sleep(0.1)
    dash({'Accuracy': a}, 0, i, len(fake_acc), is_elastic=True)

When you have several variables, set in_loop and last_for to switch among them.

e.g in_loop=(0, 1), last_for=5 means dashboard is going to show curves of var[0] and var[1] in turns. The displayed curve changes every 5 steps.

dash = tcd(format={'Acc': ['.1f', PERCENT], 'Level': ['.d', RAW]})
for i, a in enumerate(fake_acc):
    time.sleep(0.1)
    dash({'Accuracy': a, 'Level': i*i}, 0, i, len(fake_acc), in_loop=(0, 1), last_for=5)

What's more, you can even draw the gray image on the terminal.

dash = Dash(format={'I': [lambda *x:1, IMAGE]})
for i, img in enumerate(images):
    time.sleep(0.1)
    # read images here
    dash({'I': img}, 0, i, len(images))

Try to squint at the right side. :D

donut-photo.jpg donut-chars.png


📦 Installation

Install tcurve via pip

pip install tcurve

Install the following libs to access full functions.

  • numpy
  • pandas
  • matplotlib
  • seaborn

❤️ Support

If you find TCurve helpful, please give it a ⭐ on GitHub! ▶️ https://github.com/SeriaQ/TCurve

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

tcurve-0.0.2.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tcurve-0.0.2-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

Details for the file tcurve-0.0.2.tar.gz.

File metadata

  • Download URL: tcurve-0.0.2.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.12

File hashes

Hashes for tcurve-0.0.2.tar.gz
Algorithm Hash digest
SHA256 f478ae4cac09dee49d95e82075e1856353dbd0073741ec0311cc9853e0bdbefb
MD5 c361c9b41e906a1bdcf69555085f84f9
BLAKE2b-256 971110fb497853a955c37c838e4a97b89af4663a70033515f2f54e31270a0631

See more details on using hashes here.

File details

Details for the file tcurve-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: tcurve-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 13.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.12

File hashes

Hashes for tcurve-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 868f3b58887a9d7b2d6b4548973de15c8b54983dcabec636ab50f3f77e675674
MD5 ff0ae521751c0325d9c5ef2a35c29ab0
BLAKE2b-256 ae608e592b9125acbf3bf52a090e6af1cceced6057d0fe78fd98b3d14da79b4c

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