Last commit

README.rst

@@ -0,0 +1,85 @@
+TinyProgress
+============
+
+.. image:: https://img.shields.io/pypi/v/tinyprogress
+   :alt: PyPI - Version
+.. image:: https://img.shields.io/pypi/dm/tinyprogress
+   :alt: PyPI - Downloads
+.. image:: https://img.shields.io/pepy/dt/tinyprogress
+   :alt: Pepy Total Downloads
+
+
+.. image:: https://img.shields.io/github/license/croketillo/tinyprogress
+   :alt: GitHub License
+.. image:: https://img.shields.io/github/size/croketillo/tinyprogress/tinyprogress/tinyprogress.py
+   :alt: GitHub file size in bytes
+
+
+
+**TinyProgress** is a minimal and lightweight progress bar module for
+Python. It provides an easy way to track progress in loops and iterables
+without requiring external dependencies.
+
+🚀 Features
+----------
+
+-  ✅ Simple and lightweight (no external dependencies)
+-  ✅ Customizable progress bar length and characters
+-  ✅ Supports named tasks
+-  ✅ Works with any iterable
+
+📦 Installation
+--------------
+
+Since TinyProgress is a single-file module, you can simply copy
+``tinyprogress.py`` into your project.
+
+Alternatively, install it via pip (once published to PyPI):
+
+.. code:: sh
+
+   pip install tinyprogress
+
+🛠 Usage
+-------
+
+Basic Progress Bar
+~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+   from tinyprogress import progress
+   import time
+
+   for i in progress(range(100)):
+       time.sleep(0.05)  # Simulating work
+
+Custom Progress Bar Length
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+   for i in progress(range(100), bar_length=50):
+       time.sleep(0.05)
+
+Named Task Progress Bar
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+   for i in progress(range(100), task_name="Downloading"):
+       time.sleep(0.05)
+
+Using Custom Characters
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+   for i in progress(range(100), fill_char='#', empty_char='-'):
+       time.sleep(0.05)
+
+📜 License
+---------
+
+GNU General Public License v3, see LICENSE file.
+