Skip to main content

A progressbar that works well for log files and also Jupyter notebooks

Project description

# Progress Bar

[![Build Status](https://travis-ci.com/BlackHC/progress_bar.svg?branch=master)](https://travis-ci.com/BlackHC/progress_bar) [![codecov](https://codecov.io/gh/BlackHC/progress_bar/branch/master/graph/badge.svg)](https://codecov.io/gh/BlackHC/progress_bar) [![PyPI](https://img.shields.io/badge/PyPI-blackhc.progress_bar-blue.svg)](https://pypi.python.org/pypi/blackhc.progress_bar/)

A progress bar that is either using TQDM for nice outputs internally, or a log-friendly replacement that works well for piping into files.

## Example

```python
from blackhc.progress_bar import with_progress_bar

for _ in with_progress_bar(range(100000)):
pass
```

The package will decide whether to use tqdm or not based on whether output is attached to a terminal or not,
or whether the cell is executed within a Jupyter Notebook or IPython terminal.

You can use `blackhc.progress_bar.use_tqdm = True/False` to force TQDM (or force disable it).

## Installation

To install using pip, use:

```
pip install blackhc.progress_bar
```

To run the tests, use:

```
python setup.py test
```


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for blackhc.progress-bar, version 1.0.2
Filename, size File type Python version Upload date Hashes
Filename, size blackhc.progress_bar-1.0.2-py3-none-any.whl (5.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size blackhc.progress_bar-1.0.2.tar.gz (4.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page