Metadata-Version: 2.1
Name: termplots
Version: 0.2.1
Summary: A lightweight plot library for your terminal!
Author-email: Lorenzo Andreasi <lolloandreasi@gmail.com>
Project-URL: Homepage, https://github.com/lollo03/termplots
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Termplots

A lightweight plot library for your terminal

## Installation

```
pip install termplots
```

## Get started

### Simple plot

```python
import termplots as tmp

tmp.plot([-0.5,0,1,0.5,1.5], ystep=0.5)
```

Output:

```
 2.0|
 1.5|        *
 1.0|    *
 0.5|      *
 0.0|--*-------
 0.5|*
 1.0|
```

### Multiple plots

```python
import termplots as tmp

tmp.plot([[1,0,2], [-1,0,3,0,2,2]], car=['*', '$', '@'], labels=['List 1', 'List 2'])
```

Output:

```
 4|
 3|    $
 2|    *   $ $
 1|*
 0|--@---$-----
 1|$
 2|

*: List 1
$: List 2
@: overlaps
```

### Compact plot

```python
import termplots as tmp
tmp.cplot([[32,20,0, 112],[-32,-20,0,20]])
```

Output:

```
112|      *
 32|*
 20|  *   #
  0|----@---
 20|  #
 32|#
```

or

```python
import termplots as tmp
tmp.cplot([-3,2,1,15])
```

Output:

```
15|      *
 2|  *
 1|    *
 0|--------
 3|*
```

## Other arguments

### `plot()`

- `ystep` (default `1`): defines steps on the y axis
- `lowlim`: lower limit of the y axis
- `highlim`: upper limit of the y axis
- `car` (default `['*', '#', '@']`): list of point(s) marker, the last char is used for overlaps
- `labels` (default `None`): list of labels

### `cplot()`

- `car` (default `['*', '#', '@']`): list of point(s) marker, the last char is used for overlaps
- `labels` (default `None`): list of labels

## Colors

Termplots support up to 6 colors. Colors are automatically assigned to different series.

> I tested the colors only on macOS. If the colors don't work try a different terminal or open an issue
