Support for terminal plotting

[Zethson]

Hey,

what I am really missing is a package which plots awesomely looking charts/plots in the terminal.
I would love to have a package with which I could not only display tables (thanks Rich!), but also bar charts, histograms, lineplots etc.

Inspiration: https://github.com/nschloe/termplotlib

Maybe this could be a nice extension of Rich in the future?

Eager to hear what you think!
Cheers

[willmcgugan]

That would be a nice to have feature, but it would be a lot to maintain, and frankly I’m not sure I know enough about such things to do it justice.

Ideally the author of termplot could write an integration for a Rich, so we can have the best of both worlds...

[FedeClaudi]

Hi,

this works:

from rich.layout import Layout
from rich import print
from rich.panel import Panel

import termplotlib as tpl
import numpy

x = numpy.linspace(0, 2 * numpy.pi, 10)
y = numpy.sin(x)

fig = tpl.figure()
fig.plot(x, y, label="data", width=50, height=15)

print(Panel(fig.get_string(), title='myplot'))

Should be easy enough to edit termplotlib to have a __rich_console__ method, will send a PR soon to @nschloe. Then we can have both things working together :)

[Zethson]

Maybe it would also be an even better idea to add this to https://github.com/mkaz/termgraph ?

[willmcgugan]

Integrations for both libraries would be amazing to have.

[FedeClaudi]

termgraph looks cool! I will have a play with it but it should be doable.

[nschloe]

Author of termplotlib here. tpl doesn't do any plotting itself but instead relies on gnuplot's terminal output. That's because it's hard to plot on the terminal, and I concur with @willmcgugan that it would probably too much work to try and rewrite it in rich.

[FedeClaudi]

That's true, but termplot works out of the box with rich:

e.g. with

print(Panel(fig.get_string(), title='myplot'))

The only minor change would be to have termplot.Figure have a __rich_console__ method which returns the string version of the plot, to avoid having to call fig.get_string().

[willmcgugan]

Could you also specify the width of these plots? For instance, it might be nice if the "reward history" plot stretched to the available space.

[FedeClaudi]

You can, termplot.Figure has a height and width parameters. I left the space there to add another small panel ;)

[nschloe]

PR to tpl more than welcome!

[The-Compiler]

Another possible library to integrate (or just a source for inspiration) is asciichartpy (nevermind the JS-heavy readme, it's a Python port of a library which was originally written in JS). Its graphs are simple but pretty nice:

And it's code is much simpler than I expected (only some ~150 lines if you exclude a rather long docstring).

[willmcgugan]

That's rather nice. I'd love to see a port / integration with Rich. Up for a challenge @The-Compiler ? :-)

[The-Compiler]

Not at the moment I'm afraid - I personally wouldn't use it at the moment (I just got it from a friend and loved how it looks), and I'm afraid I have more than enough on my plate myself 🙂

[willmcgugan]

Fair enough. A keyboard powered browser? Very cool. I guess that makes it very quick to use once you have committed the keys to muscle memory?

[The-Compiler]

Yep - and once you get used to it, it's rather annoying to go back to using a browser "normally", similarly to how you end up with i scattered across your text files when you're used to vim but use a "normal" editor. That's why I originally started the project in 2013, because its spiritual predecessor wasn't maintained anymore and there weren't any suitable alternatives around. 🙂

FWIW I passed the idea about integrating something like asciichartpy into rich on to said friend. 🙂

[shusso]

It seems that asciichartpy works pretty nicely out-of-the-box with rich

import time
from rich.panel import Panel
from rich.live import Live

import asciichartpy as acp
import numpy as np


def simple_sine(s):
    return np.sin(2 * np.pi * (0.1 * s))

def get_panel(data):
    return Panel(acp.plot(data), expand=False, title="~~ [bold][yellow]waves[/bold][/yellow] ~~")

with Live(refresh_per_second=4) as live:
    d = []
    for i in range(1000):
        time.sleep(0.1)
        d.append(simple_sine(i))
        # pass only X latest 
        live.update(get_panel(d[-50:]))

[Abdur-rahmaanJ]

Released termcharts [pypi] with rich compatibility in mind.

[Abdur-rahmaanJ]

Thanks a lot!

[amal-khailtash]

Is there a way to add these charts to table cell/rows/columns

[Abdur-rahmaanJ]

@amal-khailtash The library above has paramter rich=True then you can use it as any rich element!

[amal-khailtash]

The question is how to add a chart to a rich table? Do you have an example?

[Abdur-rahmaanJ]

@amal-khailtash Just like you add text, as the charts boil down to a bunch of text

[snth]

I just came here to see if termgraph or something similar was supported in Rich. Glad there are some options to try.

Here's another one to add to the list:
https://github.com/mkaz/termgraph

[NikosAlexandris]

Pity, it seems to not be maintained anymore.

[WildRackoon]

For anyone finding this thread:
plotext is probably the most up to date Terminal plotting lib as of today and has official rich support documentation:

https://github.com/piccolomo/plotext/blob/master/readme/environments.md#rich