Skip to main content

Text mode diagrams using UTF-8 characters and fancy colors

Project description

# diagram

Text mode diagrams using UTF-8 characters and fancy colors (using Python).

[![Build Status][cib]][ci] [![Code Health][lsb]][ls]

[ci]: https://travis-ci.org/tehmaze/diagram [cib]: https://travis-ci.org/tehmaze/diagram.svg [ls]: https://landscape.io/github/tehmaze/diagram/issue/9/custom_colors [lsb]: https://landscape.io/github/tehmaze/diagram/issue/9/custom_colors/landscape.svg?style=flat

## Features

  • Axial graphs

  • Horizontal and vertical bar graphs

  • Supports both 3 bit (16 color) and 8 bit (256 color) mode colors with various pre-defined palettes (see below)

  • UTF-8 text graphics

## Installation

### System requirements for Fedora Core 24:

dnf install ncurses-devel ncurses-compat-libs

It’s recommended to use pip to install/update.

To install:

$ sudo pip install diagram

To update:

$ sudo pip install -U diagram

To install from github:

$ sudo pip install git+https://github.com/tehmaze/diagram.git

## Examples

Pictures say more than a thousand words.

### Axis graph

![Axis Graph](https://github.com/tehmaze/diagram/raw/master/doc/axisgraph.png)

### Horizontal bar graph

![Horizontal bar graph](https://github.com/tehmaze/diagram/raw/master/doc/horizontalbar.png)

Drawing characters used:

▏ ▎ ▍ ▌ ▋ ▊ ▉ █

### Vertical bar graph

![Vertical bar graph](https://github.com/tehmaze/diagram/raw/master/doc/verticalbar.png)

Drawing characters used:

▁ ▂ ▃ ▄ ▅ ▆ ▇ █

## Usage

Use diagram –help for documentation:

usage: diagram [-h] [-G] [-H] [-V] [-a] [-A] [-c] [-C] [-l] [-L]

[-f function] [-p palette] [-x characters] [-y characters] [-r] [-b] [-s SLEEP] [-i file] [-o file] [-e ENCODING]

optional arguments:
-h, --help

show this help message and exit

optional drawing mode:
-G, --graph

axis drawing mode (default)

-H, --horizontal-bars

horizontal drawing mode

-V, --vertical-bars

vertical drawing mode

optional drawing arguments:
-a, --axis

draw axis (default: yes)

-A, --no-axis

don’t draw axis

-c, --color

use colors (default: yes)

-C, --no-color

don’t use colors

-l, --legend

draw y-axis legend (default: yes)

-L, --no-legend

don’t draw y-axis legend

-f function, --function function

curve manipulation function, use “help” for a list

-p palette, --palette palette

palette name, use “help” for a list

-x characters, --width characters

drawing width (default: auto)

-y characters, --height characters

drawing height (default: auto)

-r, --reverse

reverse draw graph

optional input and output arguments:
-b, --batch

batch mode (default: no)

-k, --keys

input are key-value pairs (default: no) (1)

-s SLEEP, --sleep SLEEP

batch poll sleep time (default: none)

-i file, --input file

input file (default: stdin)

-o file, --output file

output file (default: stdout)

-e ENCODING, --encoding ENCODING

output encoding (default: auto)

(1): only works for the horizontal bar graph, the first argument is the key and the second value is the data point.

### –function …

The parameter can be just the function name or the function name with arguments, for example:

diagram -f log

or, with an argument:

diagram -f log:e

#### log

Symmetrical logarithmic scale.

#### smooth

Smooth (and optionally differentiate) data with a Savitzky-Golay filter.

### –palette …

#### default / spectrum

![Palette Spectrum](https://github.com/tehmaze/diagram/raw/master/doc/palette-spectrum.png)

#### grey

![Palette Grey](https://github.com/tehmaze/diagram/raw/master/doc/palette-grey.png)

#### red

![Palette Red](https://github.com/tehmaze/diagram/raw/master/doc/palette-red.png)

#### green

![Palette Green](https://github.com/tehmaze/diagram/raw/master/doc/palette-green.png)

#### blue

![Palette Blue](https://github.com/tehmaze/diagram/raw/master/doc/palette-blue.png)

## Library Usage

from diagram import DGWrapper gram = DGWrapper(data=[points, values]) gram.show()

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page