https://github.com/glentner/progressbar
Command-line progress bar for streaming files
https://github.com/glentner/progressbar
Last synced: 5 months ago
JSON representation
Command-line progress bar for streaming files
- Host: GitHub
- URL: https://github.com/glentner/progressbar
- Owner: glentner
- License: mit
- Created: 2024-01-23T03:01:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-02T00:46:18.000Z (about 1 year ago)
- Last Synced: 2025-01-04T04:22:25.977Z (6 months ago)
- Language: Python
- Size: 61.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
pb
==
[](https://opensource.org/licenses/MIT)
[](https://github.com/glentner/progressbar)
[](https://www.python.org/downloads)
A simple command-line progress bar for streaming files or lines of text.
This is simply an alternate front-end to [tqdm](https://github.com/tqdm/tqdm).
Install
-------
```sh
pipx install git+https://github.com/glentner/progressbar.git
```
Usage
-----
Use `pb --help` to get usage and help on options.
The default behavior is to display a progress bar of bytes streamed.
Positional arguments are paths to files; without any arguments we stream from `stdin`.
We get the total bytes expected by asking the file system for the size of the files.
If streaming from `stdin` we simply display current stats without the progress bar.
The output is entirely provided by [tqdm](https://github.com/tqdm/tqdm).
To count lines instead of bytes, use `--lines`.
Without a `--total` we only display stats as with `stdin`.
The `-b`, `--buffer` option is allowed in either case.
We choose an extremely large default buffer size on purpose.
Specifying counts can be explicit or with a suffix, e.g., `16K` or `10M`.
Specifying buffer size can be explicit or with a suffix, e.g., `512KB`.
Enable logging messages as an alternative to the progress bar by
using either `-v` or `-d` for INFO and DEBUG levels, respectively.
For lots of small files `-v` is appropriate; for a few large files,
`-d` will show individual buffer writes.
Why
---
I love [tqdm](https://github.com/tqdm/tqdm) but the default behavior makes
streaming files very tedious, this is a shorter syntax and automatically
computes the total size of files on disk.
Examples
--------
Stream log messages from directory:
```sh
$ ls messages/*.gz | sort | xargs pb | gunzip | grep -E '^2023-' | ...
messages/myapp.20230713.gz: 23%|█████ | 290M/1.24G [00:19<01:29, 11.4MB/s]
```
Stream 1 billion rows from file ([https://1brc.dev](https://1brc.dev)):
```sh
$ pb measurements.txt -l -t 1B | ./1brc.sh
measurements.txt: 37%|███████████▏ | 371M/1.00G [00:05<00:09, 69.3MLines/s]
```
Contributing
------------
This is finished software made for a narrow purpose.
If you find a bug or think something obvious is missing,
please feel free to open an issue or pull request with a fix.