123 lines
3.3 KiB
Markdown
123 lines
3.3 KiB
Markdown
# progressbar
|
|
|
|
[](https://travis-ci.org/schollz/progressbar)
|
|
[](https://goreportcard.com/report/github.com/schollz/progressbar)
|
|
[](https://gocover.io/github.com/schollz/progressbar)
|
|
[](https://godoc.org/github.com/schollz/progressbar)
|
|
|
|
A very simple thread-safe progress bar which should work on every OS without problems. I needed a progressbar for [croc](https://github.com/schollz/croc) and everything I tried had problems, so I made another one.
|
|
|
|
|
|
|
|
## Install
|
|
|
|
```
|
|
go get -u github.com/schollz/progressbar
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Basic usage
|
|
|
|
```golang
|
|
bar := progressbar.New(100)
|
|
for i := 0; i < 100; i++ {
|
|
bar.Add(1)
|
|
time.Sleep(10 * time.Millisecond)
|
|
}
|
|
```
|
|
|
|
which looks like:
|
|
|
|
```bash
|
|
100% |████████████████████████████████████████| [1s:0s]
|
|
```
|
|
|
|
The times at the end show the elapsed time and the remaining time, respectively.
|
|
|
|
### Long running processes
|
|
|
|
For long running processes, you might want to render from a 0% state.
|
|
|
|
```golang
|
|
// Renders the bar right on construction
|
|
bar := progressbar.NewOptions(100, progressbar.OptionSetRenderBlankState(true))
|
|
```
|
|
|
|
Alternatively, when you want to delay rendering, but still want to render a 0% state
|
|
```golang
|
|
bar := progressbar.NewOptions(100)
|
|
|
|
// Render the current state, which is 0% in this case
|
|
bar.RenderBlank()
|
|
|
|
// Emulate work
|
|
for i := 0; i < 10; i++ {
|
|
time.Sleep(10 * time.Minute)
|
|
bar.Add(10)
|
|
}
|
|
```
|
|
|
|
### Use a custom writer
|
|
|
|
The default writer is standard output (os.Stdout), but you can set it to whatever satisfies io.Writer.
|
|
```golang
|
|
bar := NewOptions(
|
|
10,
|
|
OptionSetTheme(Theme{Saucer: "#", SaucerPadding: "-", BarStart: ">", BarEnd: "<"}),
|
|
OptionSetWidth(10),
|
|
OptionSetWriter(&buf),
|
|
)
|
|
|
|
bar.Add(5)
|
|
result := strings.TrimSpace(buf.String())
|
|
|
|
// Result equals:
|
|
// 50% >#####-----< [0s:0s]
|
|
|
|
```
|
|
|
|
### Progress for I/O operations
|
|
|
|
The `progressbar` implements an `io.Writer` so it can automatically detect the number of bytes written to a stream, so you can use it as a progressbar for an `io.Reader`.
|
|
|
|
```golang
|
|
urlToGet := "https://github.com/schollz/croc/releases/download/v4.1.4/croc_v4.1.4_Windows-64bit_GUI.zip"
|
|
req, _ := http.NewRequest("GET", urlToGet, nil)
|
|
resp, _ := http.DefaultClient.Do(req)
|
|
defer resp.Body.Close()
|
|
|
|
var out io.Writer
|
|
f, _ := os.OpenFile("croc_v4.1.4_Windows-64bit_GUI.zip", os.O_CREATE|os.O_WRONLY, 0644)
|
|
out = f
|
|
defer f.Close()
|
|
|
|
bar := progressbar.NewOptions(
|
|
int(resp.ContentLength),
|
|
progressbar.OptionSetBytes(int(resp.ContentLength)),
|
|
)
|
|
out = io.MultiWriter(out, bar)
|
|
io.Copy(out, resp.Body)
|
|
```
|
|
|
|
See the tests for another example.
|
|
|
|
## Contributing
|
|
|
|
Pull requests are welcome. Feel free to...
|
|
|
|
- Revise documentation
|
|
- Add new features
|
|
- Fix bugs
|
|
- Suggest improvements
|
|
|
|
## Thanks
|
|
|
|
Thanks [@Dynom](https://github.com/dynom) for massive improvements in version 2.0!
|
|
|
|
Thanks [@CrushedPixel](https://github.com/CrushedPixel) for adding descriptions and color code support!
|
|
|
|
## License
|
|
|
|
MIT
|