progress-table 2.3.2__tar.gz → 3.0.1__tar.gz

progress_table-3.0.1/.gitignore

@@ -0,0 +1,10 @@
+.idea
+.ipynb_checkpoints
+*.ipynb
+__pycache__
+*.egg-info
+
+devel/
+dist
+build
+*.sh

{progress_table-2.3.2 → progress_table-3.0.1}/PKG-INFO

@@ -1,11 +1,12 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: progress-table
-Version: 2.3.2
+Version: 3.0.1
 Summary: Display progress as a pretty table in the command line.
-Home-page: https://github.com/gahaalt/progress-table.git
-Author: Szymon Mikler
-Author-email: sjmikler@gmail.com
+Project-URL: Home, https://github.com/gahaalt/progress-table
+Project-URL: Documentation, https://github.com/sjmikler/progress-table/blob/main/docs
+Author-email: Szymon Mikler <sjmikler@gmail.com>
 License: MIT
+License-File: LICENSE.txt
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.7
@@ -14,22 +15,19 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
 Requires-Dist: colorama
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-> Version 2.X introduces new features and new interactive modes.
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: isort; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+> Version 2.x.x introduces new features and new interactive modes.
+>
+> Version 3.x.x improves compatibility and stability.
 >
 > New features allow for previously impossible applications, see examples below.
 
@@ -47,29 +45,31 @@ Lightweight utility to display the progress of your process as a pretty table in
 
 ### Change this:
 
-![example](https://raw.githubusercontent.com/sjmikler/progress-table/main/images/progress-before3.gif)
+![example](images/progress-before3.gif)
 
 ### Into this:
 
-![example](https://raw.githubusercontent.com/sjmikler/progress-table/main/images/progress-after4.gif)
+![example](images/progress-after4.gif)
 
 ## Examples
 
+From `examples/` directory:
+
 * Neural network training
 
-![example-training](https://raw.githubusercontent.com/sjmikler/progress-table/main/images/examples-training.gif)
+![example-training](images/examples-training.gif)
 
 * Progress of multi-threaded downloads
 
-![example-download](https://raw.githubusercontent.com/sjmikler/progress-table/main/images/examples-download.gif)
+![example-download](images/examples-download.gif)
 
 * Simulation and interactive display of Brownian motion
 
-![example-brown2d](https://raw.githubusercontent.com/sjmikler/progress-table/main/images/examples-brown2d.gif)
+![example-brown2d](images/examples-brown2d.gif)
 
 * Display of a game board
 
-![example-tictactoe](https://raw.githubusercontent.com/sjmikler/progress-table/main/images/examples-tictactoe.gif)
+![example-tictactoe](images/examples-tictactoe.gif)
 
 ## Quick start code
 
@@ -110,12 +110,12 @@ table.close()
 
 ```
 
-> Go to [integrations](https://github.com/sjmikler/progress-table/blob/main/docs//integrations.md)
+> Go to [integrations](docs/integrations.md)
 > page to see examples of integration with deep learning libraries.
 
 ## Advanced usage
 
-Go to [advanced usage](https://github.com/sjmikler/progress-table/blob/main/docs//advanced-usage.md) page for more information.
+Go to [advanced usage](docs/advanced-usage.md) page for more information.
 
 ## Troubleshooting
 
@@ -123,13 +123,11 @@ Go to [advanced usage](https://github.com/sjmikler/progress-table/blob/main/docs
 
 Progress Table works correctly in most consoles, but there are some exceptions:
 
-* Some cloud logging consoles (e.g. kubernetes) don't support `\r` properly.
-  You can still use ProgressTable, but with `interactive=0` option. This mode will not display progress bars.
-* Some consoles like `PyCharm Python Console` or `IDLE` don't support cursor movement.
-  You can still use ProgressTable, but with `interactive=1` option. This mode displays only 1 progress bar at once.
+* Some cloud logging consoles (e.g. kubernetes) don't support `\r` properly. You can still use ProgressTable, but with `interactive=0` option. This mode will not display progress bars.
+
+* Some consoles like 'PyCharm Python Console' or 'IDLE' don't support cursor movement. You can still use ProgressTable, but with `interactive=1` option. In this mode, you can display only a single progress bar.
 
-> By default `interactive=2`. You can change the default `interactive` with an argument when creating the table object
-> or by setting `PTABLE_INTERACTIVE` environment variable, e.g. `PTABLE_INTERACTIVE=1`.
+> By default `interactive=2`. You can change the default 'interactive' with an argument when creating the table object or by setting 'PTABLE_INTERACTIVE' environment variable, e.g. `PTABLE_INTERACTIVE=1`.
 
 ### Other problems
 

{progress_table-2.3.2 → progress_table-3.0.1}/README.md

@@ -1,4 +1,6 @@
-> Version 2.X introduces new features and new interactive modes.
+> Version 2.x.x introduces new features and new interactive modes.
+>
+> Version 3.x.x improves compatibility and stability.
 >
 > New features allow for previously impossible applications, see examples below.
 
@@ -24,6 +26,8 @@ Lightweight utility to display the progress of your process as a pretty table in
 
 ## Examples
 
+From `examples/` directory:
+
 * Neural network training
 
 ![example-training](images/examples-training.gif)
@@ -92,13 +96,11 @@ Go to [advanced usage](docs/advanced-usage.md) page for more information.
 
 Progress Table works correctly in most consoles, but there are some exceptions:
 
-* Some cloud logging consoles (e.g. kubernetes) don't support `\r` properly.
-  You can still use ProgressTable, but with `interactive=0` option. This mode will not display progress bars.
-* Some consoles like `PyCharm Python Console` or `IDLE` don't support cursor movement.
-  You can still use ProgressTable, but with `interactive=1` option. This mode displays only 1 progress bar at once.
+* Some cloud logging consoles (e.g. kubernetes) don't support `\r` properly. You can still use ProgressTable, but with `interactive=0` option. This mode will not display progress bars.
+
+* Some consoles like 'PyCharm Python Console' or 'IDLE' don't support cursor movement. You can still use ProgressTable, but with `interactive=1` option. In this mode, you can display only a single progress bar.
 
-> By default `interactive=2`. You can change the default `interactive` with an argument when creating the table object
-> or by setting `PTABLE_INTERACTIVE` environment variable, e.g. `PTABLE_INTERACTIVE=1`.
+> By default `interactive=2`. You can change the default 'interactive' with an argument when creating the table object or by setting 'PTABLE_INTERACTIVE' environment variable, e.g. `PTABLE_INTERACTIVE=1`.
 
 ### Other problems
 

progress_table-3.0.1/progress_table/__init__.py

@@ -0,0 +1,18 @@
+#  Copyright (c) 2022-2025 Szymon Mikler
+#  Licensed under the MIT License
+
+"""Progress Table provides an easy and pretty way to track your process.
+
+Supported features:
+    - Styling and coloring
+    - Modifying existing cells
+    - Progress bars integrated into the table
+"""
+
+__license__ = "MIT"
+__version__ = "3.0.1"
+__author__ = "Szymon Mikler"
+
+from progress_table.progress_table import ProgressTable, styles
+
+__all__ = ["ProgressTable", "styles"]

{progress_table-2.3.2/progress_table/v1 → progress_table-3.0.1/progress_table}/common.py

@@ -1,6 +1,7 @@
-#  Copyright (c) 2022-2024 Szymon Mikler
+#  Copyright (c) 2022-2025 Szymon Mikler
+#  Licensed under the MIT License
 
-from __future__ import annotations
+"""Common utilities for progress_table."""
 
 from typing import Union
 
@@ -20,12 +21,11 @@ COLORAMA_TRANSLATE = {
 NoneType = type(None)
 ColorFormat = Union[str, tuple, list, NoneType]
 ColorFormatTuple = (str, tuple, list, NoneType)
-
 CURSOR_UP = "\033[A"
 
 
 def maybe_convert_to_colorama_str(color: str) -> str:
-    # Translation layer to fix unintuitive colorama names
+    """Convert color from string to colorama string."""
     color = COLORAMA_TRANSLATE.get(color.lower(), color)
 
     if isinstance(color, str):
@@ -39,6 +39,10 @@ def maybe_convert_to_colorama_str(color: str) -> str:
 
 
 def maybe_convert_to_colorama(color: ColorFormat) -> str:
+    """Fix unintuitive colorama names.
+
+    Translation layer from user-passed to colorama-compatible names.
+    """
     if color is None or color == "":
         return ""
     if isinstance(color, str):