diff --git a/.gitignore b/.gitignore index 1b40a88..b546818 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,4 @@ -# Ignore manifest MANIFEST - -# Ignore dist dist +gifs +.DS_Store diff --git a/README.md b/README.md index e8f2bb1..3ce46fa 100644 --- a/README.md +++ b/README.md @@ -1 +1,99 @@ # p_tqdm - parallel processing with progress bars + +`p_tqdm` provides implementations of parallel and sequential map functions using [tqdm](https://github.com/tqdm/tqdm) progress bars. + +Since `p_tqdm` uses [pathos.multiprocessing](https://github.com/uqfoundation/pathos/blob/master/pathos/multiprocessing.py) instead of the regular python [multiprocessing](https://docs.python.org/3/library/multiprocessing.html) module, its parallel maps can apply almost any type of function, including lambda functions, nested functions, and class methods. + +## Installation + +```pip install p_tqdm``` + +## p_map - parallel ordered map + +```python +from p_tqdm import p_map + +def func(a, b): + return a + b + +results = p_map(func, ['1', '2', '3'], ['a', 'b', 'c']) +``` + +``` + 0%| | 0/3 [00:00