File: README.md

package info (click to toggle)
golang-github-tatsushid-go-prettytable 0.0~git20141013.ed2d14c-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 88 kB
  • sloc: makefile: 2
file content (79 lines) | stat: -rw-r--r-- 1,702 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
go-prettytable
==============

go-prettytable is a library for Golang to build a simple text table with a
multibyte, doublewidth character support.

[![GoDoc](https://godoc.org/github.com/tatsushid/go-prettytable?status.svg)](https://godoc.org/github.com/tatsushid/go-prettytable)

## Installation

Install and update this go package with `go get -u
github.com/tatsushid/go-prettytable`

## Examples

Import this package and use

```go
tbl, err := prettytable.NewTable([]prettytable.Column{
	{Header: "COL1"},
	{Header: "COL2", MinWidth: 6},
	{Header: "COL3", AlignRight: true},
}...)
if err != nil {
	panic(err)
}
tbl.Separator = " | "
tbl.AddRow("foo", "bar", "baz")
tbl.AddRow(1, 2.3, 4)
tbl.Print()
```

It outputs

```
COL1 | COL2   | COL3
foo  | bar    |  baz
1    | 2.3    |    4
```

Also it can be used with multibyte, doublewidth characters

```go
tbl, err := prettytable.NewTable([]prettytable.Column{
	{Header: "名前"},
	{Header: "個数", AlignRight: true},
}...)
if err != nil {
	panic(err)
}
tbl.Separator = " | "
tbl.AddRow("りんご", 5)
tbl.AddRow("みかん", 3)
tbl.AddRow("柿", 2)
tbl.Print()
```

It outputs (may not be displayed correctly with proportional fonts but it
is displeyed good on terminal)

```
名前   | 個数
りんご |    5
みかん |    3
柿     |    2
```

For more detail, please see [godoc][godoc].

## See Also
- [gotabulate](https://github.com/bndr/gotabulate)
- [go-texttable](https://github.com/syohex/go-texttable)

## License
go-prettytable is under MIT License. See the [LICENSE][license] file for
details.

[godoc]: http://godoc.org/github.com/tatsushid/go-prettytable
[license]: https://github.com/tatsushid/go-prettytable/blob/master/LICENSE