<commit_before>PyProgress
==========
CLI script progress output library

See code for documentation

Run the library standalone to see the different options in action

ProgressBar
----------

Both non-threaded and threaded versions let you call an increment function and output a progress bar of your program.

Options let you show running time, estimated completion time and counts.

DoubleProgressBar
-----------------

Similar to the ProgressBar except it has a second sub progress bar for long running scripts with sub tasks

Counter
-------

Simply counts up values!

Spinner
-------

The simplest of the lot, display a waiting spinner<commit_msg>Added example to README<commit_after>PyProgress
==========
CLI script progress output library

See code for documentation

Run the library standalone to see the different options in action

ProgressBar
----------

Both non-threaded and threaded versions let you call an increment function and output a progress bar of your program.

Options let you show running time, estimated completion time and counts.

#### Example
```
ProgressBar 0:12:34.123456 300.000 [###########################             ] 130/200
Name        Runtime        ETC      Progress                                  Completed/Total
```

DoubleProgressBar
-----------------

Similar to the ProgressBar except it has a second sub progress bar for long running scripts with sub tasks

#### Example
```
DoublePB 0:00:07.763144 46.846 [########                                ] 2/10 [######              ] 3/10  total:14 2.000/s
Name     Runtime        ETC      Main Progress                    Completed/Total   Sub progress   Completed/Total Overall count
```

Counter
-------

Simply counts up values!

Spinner
-------

The simplest of the lot, display a waiting spinner
{'fraction_non_alphanumeric': 0.11383928571428571, 'fraction_numerical': 0.028459821428571428, 'mean_word_length': 2.593186372745491, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3152861', 'n_tokens_mistral': 468, 'n_tokens_neox': 408, 'n_words': 205}