From a73fb52804c32f0cc38745eff2f105bdae1b2e6d Mon Sep 17 00:00:00 2001 From: Cody Baker <51133164+CodyCBakerPhD@users.noreply.github.com> Date: Thu, 18 Jan 2024 14:43:31 -0500 Subject: [PATCH] adjust license links --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d06716d..b1e0bc6 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # tqdm-publisher -[![PyPI version](https://badge.fury.io/py/tqdm-publisher.svg)](https://badge.fury.io/py/tqdm-publisher.svg) -[![License](https://img.shields.io/pypi/l/tqdm-publisher.svg)](https://github.com/catalystneuro/tqdm-publisher/license.txt) +[![PyPI version](https://badge.fury.io/py/tqdm_publisher.svg)](https://badge.fury.io/py/tqdm_publisher.svg) +[![License](https://img.shields.io/pypi/l/tqdm_publisher.svg)](https://github.com/catalystneuro/tqdm_publisher/blob/main/license.txt) -`tqdm-publisher` is a small Python package that allows you to subscribe to updates from `tqdm` progress bars with arbitrary callback functions. +`tqdm_publisher` is a small Python package that allows you to subscribe to updates from `tqdm` progress bars with arbitrary callback functions. This is useful if you want to use `tqdm` to track the progress of a long-running task, but you also want to do something else with the progress information (e.g., forward it to a user interface, log it to a file, etc.). ## Installation ```bash -pip install tqdm-publisher +pip install tqdm_publisher ``` ## Usage @@ -40,4 +40,4 @@ async def run_multiple_sleeps(sleep_durations): n = 10**5 sleep_durations = [random.uniform(0, 5.0) for _ in range(n)] asyncio.run(run_multiple_sleeps(sleep_durations=sleep_durations)) -``` \ No newline at end of file +```