Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkaz/termgraph
a python command-line tool which draws basic graphs in the terminal
https://github.com/mkaz/termgraph
Last synced: 4 days ago
JSON representation
a python command-line tool which draws basic graphs in the terminal
- Host: GitHub
- URL: https://github.com/mkaz/termgraph
- Owner: mkaz
- License: mit
- Created: 2012-09-21T18:31:27.000Z (about 12 years ago)
- Default Branch: main
- Last Pushed: 2024-06-15T13:04:55.000Z (6 months ago)
- Last Synced: 2024-12-02T23:06:34.411Z (11 days ago)
- Language: Python
- Size: 659 KB
- Stars: 3,149
- Watchers: 42
- Forks: 165
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Termgraph
A command-line tool that draws basic graphs in the terminal, written in Python.
Graph types supported:
- Bar Graphs
- Color charts
- Multi-variable
- Stacked charts
- Histograms
- Horizontal or Vertical
- Emoji!
### Examples
```
termgraph data/ex1.dat
# Reading data from data/ex1.dat
2007: ▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 183.32
2008: ▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 231.23
2009: ▇ 16.43
2010: ▇▇▇▇ 50.21
2011: ▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 508.97
2012: ▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 212.05
2014: ▏ 1.00
```
An example using emoji as custom tick:
```
termgraph data/ex1.dat --custom-tick "🏃" --width 20 --title "Running Data"
# Running Data
2007: 🏃🏃🏃🏃🏃🏃🏃 183.32
2008: 🏃🏃🏃🏃🏃🏃🏃🏃🏃 231.23
2009: 16.43
2010: 🏃 50.21
2011: 🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃 508.97
2012: 🏃🏃🏃🏃🏃🏃🏃🏃 212.05
2014: 1.00
```
An example using stdin and emoji:
```
echo "Label,3,9,1" | termgraph --custom-tick "😀" --no-label
😀😀😀 3.00
😀😀😀😀😀😀😀😀😀 9.00
😀 1.00
```
Most results can be copied and pasted wherever you like, since they use standard block characters. However the color charts will not show, since they use terminal escape codes for color. A couple images to show color examples:
```
termgraph data/ex4.dat --color {blue,red}
```
```
termgraph data/ex7.dat --color {yellow,magenta} --stacked --title "Stacked Data"
```
Calendar Heatmap, expects first column to be date in yyyy-mm-dd
```
termgraph --calendar --start-dt 2017-07-01 data/cal.dat
```
### Install
Requires Python 3.7+, install from [PyPI project](https://pypi.org/project/termgraph/)
```
python3 -m pip install termgraph
```
Note: Be sure your PATH includes the pypi install directory, for me it is `~/.local/bin/`
### Usage
* Create data file with two columns either comma or space separated.
The first column is your labels, the second column is a numeric data
* termgraph [datafile]
* Help: termgraph -h
```
usage: termgraph.py [-h] [(optional arguments)] [filename]
draw basic graphs on terminal
positional arguments:
filename data file name (comma or space separated). Defaults to stdin.
optional arguments:
-h, --help show this help message and exit
--title TITLE Title of graph
--width WIDTH width of graph in characters default:50
--format FORMAT format specifier to use.
--suffix SUFFIX string to add as a suffix to all data points.
--no-labels Do not print the label column
--no-values Do not print the values at end
--space-between Print a new line after every field
--color [COLOR ...] Graph bar color( s )
--vertical Vertical graph
--stacked Stacked bar graph
--histogram Histogram
--bins BINS Bins of Histogram
--different-scale Categories have different scales.
--calendar Calendar Heatmap chart
--start-dt START_DT Start date for Calendar chart
--custom-tick CUSTOM_TICK
Custom tick mark, emoji approved
--delim DELIM Custom delimiter, default , or space
--verbose Verbose output, helpful for debugging
--label-before Display the values before the bars
--version Display version and exit
```
### Background
I wanted a quick way to visualize data stored in a simple text file. I initially created some scripts in R that generated graphs but this was a two step process of creating the graph and then opening the generated graph.
After seeing [command-line sparklines](https://github.com/holman/spark) I figured I could do the same thing using block characters for bar charts.
### Contribute
All contributions are welcome, for feature requests or bug reports, use [Github Issues](https://github.com/mkaz/termgraph/issues). Pull requests are welcome to help fix or add features.
**Code contributions**: This repository uses the [black code formatter](https://github.com/psf/black) to automatically format the code. A Github Action is setup to lint your code, to avoid failures it is recommended to [setup your editor to auto format on save](https://github.com/psf/black/blob/master/docs/editor_integration.md).
Thanks to all the [contributors](https://github.com/mkaz/termgraph/graphs/contributors)!
### License
MIT License, see [LICENSE.txt](LICENSE.txt)