cli graph graphs

2025-05-07 15:34:31 -06:00
parent 2f8dba4e23
commit 58462fb5a4
403 changed files with 226724 additions and 4 deletions
--- a/vendor/github.com/guptarohit/asciigraph/README.md
+++ b/vendor/github.com/guptarohit/asciigraph/README.md
@@ -0,0 +1,292 @@
+# asciigraph
+
+[![Build status][]][1] [![Go Report Card][]][2] [![Coverage Status][]][3] [![GoDoc][]][4] [![License][]][5] [![Mentioned in Awesome Go][]][6]
+
+Go package to make lightweight ASCII line graphs ╭┈╯.
+
+![image][]
+
+## Installation
+```bash
+go get -u github.com/guptarohit/asciigraph@latest
+```
+
+## Usage
+
+### Basic graph
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/guptarohit/asciigraph"
+)
+
+func main() {
+    data := []float64{3, 4, 9, 6, 2, 4, 5, 8, 5, 10, 2, 7, 2, 5, 6}
+    graph := asciigraph.Plot(data)
+
+    fmt.Println(graph)
+}
+```
+
+Running this example would render the following graph:
+```bash
+  10.00 ┤        ╭╮
+   9.00 ┤ ╭╮     ││
+   8.00 ┤ ││   ╭╮││
+   7.00 ┤ ││   ││││╭╮
+   6.00 ┤ │╰╮  ││││││ ╭
+   5.00 ┤ │ │ ╭╯╰╯│││╭╯
+   4.00 ┤╭╯ │╭╯   ││││
+   3.00 ┼╯  ││    ││││
+   2.00 ┤   ╰╯    ╰╯╰╯
+```
+
+### Multiple Series
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/guptarohit/asciigraph"
+)
+
+func main() {
+	data := [][]float64{{0, 1, 2, 3, 3, 3, 2, 0}, {5, 4, 2, 1, 4, 6, 6}}
+	graph := asciigraph.PlotMany(data)
+
+	fmt.Println(graph)
+}
+```
+
+Running this example would render the following graph:
+```bash
+ 6.00 ┤    ╭─
+ 5.00 ┼╮   │
+ 4.00 ┤╰╮ ╭╯
+ 3.00 ┤ │╭│─╮
+ 2.00 ┤ ╰╮│ ╰╮
+ 1.00 ┤╭╯╰╯  │
+ 0.00 ┼╯     ╰
+```
+
+### Colored graphs
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/guptarohit/asciigraph"
+)
+
+func main() {
+	data := make([][]float64, 4)
+
+	for i := 0; i < 4; i++ {
+		for x := -20; x <= 20; x++ {
+			v := math.NaN()
+			if r := 20 - i; x >= -r && x <= r {
+				v = math.Sqrt(math.Pow(float64(r), 2)-math.Pow(float64(x), 2)) / 2
+			}
+			data[i] = append(data[i], v)
+		}
+	}
+	graph := asciigraph.PlotMany(data, asciigraph.Precision(0), asciigraph.SeriesColors(
+		asciigraph.Red,
+		asciigraph.Yellow,
+		asciigraph.Green,
+		asciigraph.Blue,
+	))
+
+	fmt.Println(graph)
+}
+```
+
+Running this example would render the following graph:
+
+![colored_graph_image][]
+
+### Legends for colored graphs
+
+The graph can include legends for each series, making it easier to interpret.
+
+```go
+package main
+
+import (
+	"fmt"
+	"github.com/guptarohit/asciigraph"
+	"math"
+)
+
+func main() {
+	data := make([][]float64, 3)
+	for i := 0; i < 3; i++ {
+		for x := -12; x <= 12; x++ {
+			v := math.NaN()
+			if r := 12 - i; x >= -r && x <= r {
+				v = math.Sqrt(math.Pow(float64(r), 2)-math.Pow(float64(x), 2)) / 2
+			}
+			data[i] = append(data[i], v)
+		}
+	}
+	graph := asciigraph.PlotMany(data,
+		asciigraph.Precision(0),
+		asciigraph.SeriesColors(asciigraph.Red, asciigraph.Green, asciigraph.Blue),
+		asciigraph.SeriesLegends("Red", "Green", "Blue"),
+		asciigraph.Caption("Series with legends"))
+	fmt.Println(graph)
+}
+```
+Running this example would render the following graph:
+
+![graph_with_legends_image][]
+
+
+## CLI Installation
+
+This package also brings a small utility for command line usage.
+
+Assuming `$GOPATH/bin` is in your `$PATH`, install CLI with following command:
+```bash
+go install github.com/guptarohit/asciigraph/cmd/asciigraph@latest
+```
+
+or pull Docker image:
+```bash
+docker pull ghcr.io/guptarohit/asciigraph:latest
+```
+
+or download binaries from the [releases][] page.
+
+
+## CLI Usage
+
+```bash                                                                                                                ✘ 0|125  16:19:23
+> asciigraph --help
+Usage of asciigraph:
+  asciigraph [options]
+Options:
+  -ac axis color
+    	y-axis color of the plot
+  -b buffer
+    	data points buffer when realtime graph enabled, default equal to `width`
+  -c caption
+    	caption for the graph
+  -cc caption color
+    	caption color of the plot
+  -d delimiter
+    	data delimiter for splitting data points in the input stream (default ",")
+  -f fps
+    	set fps to control how frequently graph to be rendered when realtime graph enabled (default 24)
+  -h height
+    	height in text rows, 0 for auto-scaling
+  -lb lower bound
+    	lower bound set the minimum value for the vertical axis (ignored if series contains lower values) (default +Inf)
+  -lc label color
+    	y-axis label color of the plot
+  -o offset
+    	offset in columns, for the label (default 3)
+  -p precision
+    	precision of data point labels along the y-axis (default 2)
+  -r realtime
+    	enables realtime graph for data stream
+  -sc series colors
+    	comma-separated series colors corresponding to each series
+  -sl series legends
+    	comma-separated series legends corresponding to each series
+  -sn number of series
+    	number of series (columns) in the input data (default 1)
+  -ub upper bound
+    	upper bound set the maximum value for the vertical axis (ignored if series contains larger values) (default -Inf)
+  -w width
+    	width in columns, 0 for auto-scaling
+asciigraph expects data points from stdin. Invalid values are logged to stderr.
+```
+
+
+Feed it data points via stdin:
+```bash
+seq 1 72 | asciigraph -h 10 -c "plot data from stdin"
+```
+
+or use Docker image:
+```bash
+seq 1 72 | docker run -i --rm ghcr.io/guptarohit/asciigraph -h 10 -c "plot data from stdin"
+```
+
+Output:
+
+```bash
+ 72.00 ┤                                                                  ╭────
+ 64.90 ┤                                                           ╭──────╯
+ 57.80 ┤                                                    ╭──────╯
+ 50.70 ┤                                             ╭──────╯
+ 43.60 ┤                                      ╭──────╯
+ 36.50 ┤                              ╭───────╯
+ 29.40 ┤                       ╭──────╯
+ 22.30 ┤                ╭──────╯
+ 15.20 ┤         ╭──────╯
+  8.10 ┤  ╭──────╯
+  1.00 ┼──╯
+                                  plot data from stdin
+```
+
+
+Example of **real-time graph** for data points stream via stdin:
+
+<a href="https://asciinema.org/a/382383" target="_blank"><img width="500" alt="Realtime graph for data points via stdin (google ping) using asciigraph" src="https://asciinema.org/a/382383.svg" /></a>
+
+<details>
+<summary>command for above graph</summary>
+
+```sh
+ping -i.2 google.com | grep -oP '(?<=time=).*(?=ms)' --line-buffered | asciigraph -r -h 10 -w 40 -c "realtime plot data (google ping in ms) from stdin"
+```
+</details>
+
+
+Example of **multi-series real-time graph** for data points stream via stdin:
+
+<a href="https://asciinema.org/a/649906" target="_blank"><img width="500" alt="Ping latency comparison: Google (Blue) vs. DuckDuckGo (Red) with asciigraph" src="https://asciinema.org/a/649906.svg" /></a>
+
+<details>
+<summary>command for above graph</summary>
+
+```sh
+{unbuffer paste -d, <(ping -i 0.4 google.com | sed -u -n -E 's/.*time=(.*)ms.*/\1/p') <(ping -i 0.4 duckduckgo.com | sed -u -n -E 's/.*time=(.*)ms.*/\1/p') } | asciigraph -r -h 15 -w 60 -sn 2 -sc "blue,red" -c "Ping Latency Comparison" -sl "Google, DuckDuckGo"
+```
+</details>
+
+
+## Acknowledgement
+
+This package started as golang port of [asciichart][].
+
+
+## Contributing
+
+Feel free to make a pull request! :octocat:
+
+
+[Build status]: https://github.com/guptarohit/asciigraph/actions/workflows/test.yml/badge.svg
+[1]: https://github.com/guptarohit/asciigraph/actions/workflows/test.yml
+[Go Report Card]: https://goreportcard.com/badge/github.com/guptarohit/asciigraph
+[2]: https://goreportcard.com/report/github.com/guptarohit/asciigraph
+[Coverage Status]: https://coveralls.io/repos/github/guptarohit/asciigraph/badge.svg?branch=master
+[3]: https://coveralls.io/github/guptarohit/asciigraph?branch=master
+[GoDoc]: https://godoc.org/github.com/guptarohit/asciigraph?status.svg
+[4]: https://godoc.org/github.com/guptarohit/asciigraph
+[License]: https://img.shields.io/badge/licence-BSD-blue.svg
+[5]: https://github.com/guptarohit/asciigraph/blob/master/LICENSE
+[Mentioned in Awesome Go]: https://awesome.re/mentioned-badge-flat.svg
+[6]: https://github.com/avelino/awesome-go#advanced-console-uis
+[image]: https://user-images.githubusercontent.com/7895001/41509956-b1b2b3d0-7279-11e8-9d19-d7dea17d5e44.png
+[colored_graph_image]: https://user-images.githubusercontent.com/7895001/166443444-40ad8113-2c0f-46d7-9c75-1cf08435ce15.png
+[releases]: https://github.com/guptarohit/asciigraph/releases
+[asciichart]: https://github.com/kroitor/asciichart
+[graph_with_legends_image]: https://github.com/guptarohit/asciigraph/assets/7895001/4066ee95-55ca-42a4-8a03-e73ce20df5d3