README.md

# Tqdm

Add a progress bar to your enumerables in a second.

A (partial) port of Python's [tqdm](https://github.com/tqdm/tqdm) to Elixir. Thanks noamraph and all other contributors for the original library!

Wrap your favorite enumerables (i.e. Lists, Maps, Streams, anything that implements Enumerable!) with tqdm, and see progress in detail!

For example:

```elixir
for _ <- Tqdm.tqdm(1..1000) do
  :timer.sleep(10)
end
```

will give you a nice progress bar like:

```
|######----| 665/1000 67.0% [elapsed: 00:00:10.522247 left: 00:00:05, 63.2 iters/sec]
```

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:

  1. Add tqdm to your list of dependencies in `mix.exs`:

        def deps do
          [{:tqdm, "~> 0.0.1"}]
        end

  2. Ensure tqdm is started before your application:

        def application do
          [applications: [:tqdm]]
        end