PyPI - stouputils - Versions diffs - 1.0.17__tar.gz → 1.15.0__tar.gz - Mend

stouputils 1.0.17tar.gz → 1.15.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (166) hide show

stouputils-1.15.0/PKG-INFO ADDED Viewed

@@ -0,0 +1,178 @@
+Metadata-Version: 2.3
+Name: stouputils
+Version: 1.15.0
+Summary: Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more.
+Keywords: utilities,tools,helpers,development,python
+Author: Stoupy51
+Author-email: Stoupy51 <stoupy51@gmail.com>
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Dist: tqdm>=4.0.0
+Requires-Dist: requests>=2.20.0
+Requires-Dist: msgspec[toml,yaml]>=0.20.0
+Requires-Dist: pillow>=12.0.0
+Requires-Dist: python-box>=7.0.0
+Requires-Dist: argcomplete>=3.0.0
+Requires-Dist: numpy
+Requires-Dist: opencv-python ; extra == 'data-science'
+Requires-Dist: scikit-image ; extra == 'data-science'
+Requires-Dist: simpleitk ; extra == 'data-science'
+Requires-Dist: mlflow ; extra == 'data-science'
+Requires-Dist: tensorflow ; extra == 'data-science'
+Requires-Dist: scikit-learn ; extra == 'data-science'
+Requires-Dist: pywavelets ; extra == 'data-science'
+Requires-Dist: m2r2 ; extra == 'docs'
+Requires-Dist: myst-parser ; extra == 'docs'
+Requires-Dist: sphinx-copybutton ; extra == 'docs'
+Requires-Dist: sphinx-design ; extra == 'docs'
+Requires-Dist: sphinx-treeview ; extra == 'docs'
+Requires-Dist: sphinx-breeze-theme ; extra == 'docs'
+Requires-Dist: pydata-sphinx-theme ; extra == 'docs'
+Requires-Python: >=3.12
+Project-URL: Homepage, https://stoupy51.github.io/stouputils
+Project-URL: Issues, https://github.com/Stoupy51/stouputils/issues
+Project-URL: Source, https://github.com/Stoupy51/stouputils
+Provides-Extra: data-science
+Provides-Extra: docs
+Description-Content-Type: text/markdown
+## 🛠️ Project Badges
+[![GitHub](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=github&label=GitHub)](https://github.com/Stoupy51/stouputils/releases/latest)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/stouputils?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stouputils/)
+[![Documentation](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=sphinx&label=Documentation&color=purple)](https://stoupy51.github.io/stouputils/latest/)
+## 📚 Project Overview
+Stouputils is a collection of utility modules designed to simplify and enhance the development process.<br>
+It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers.<br>
+Start now by installing the package: `pip install stouputils`.<br>
+<a href="https://colab.research.google.com/drive/1mJ-KL-zXzIk1oKDxO6FC1SFfm-BVKG-P?usp=sharing" target="_blank" rel="noopener noreferrer" style="text-decoration: none;"><div class="admonition">
+📖 <b>Want to see examples?</b> Check out our <u>Google Colab notebook</u> with practical usage examples!
+</div></a>
+## 🚀 Project File Tree
+<html>
+<details style="display: none;">
+<summary></summary>
+<style>
+.code-tree {
+	border-radius: 6px;
+	padding: 16px;
+	font-family: monospace;
+	line-height: 1.45;
+	overflow: auto;
+	white-space: pre;
+	background-color:rgb(43, 43, 43);
+	color: #d4d4d4;
+}
+.code-tree a {
+	color: #569cd6;
+	text-decoration: none;
+}
+.code-tree a:hover {
+	text-decoration: underline;
+}
+.code-tree .comment {
+	color:rgb(231, 213, 48);
+}
+.code-tree .paren {
+	color: orange;
+}
+</style>
+</details>
+<pre class="code-tree">stouputils/
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.print.html">print.py</a>         <span class="comment"># 🖨️ Utility functions for printing <span class="paren">(info, debug, warning, error, whatisit, breakpoint, colored_for_loop, ...)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.decorators.html">decorators.py</a>    <span class="comment"># 🎯 Decorators <span class="paren">(measure_time, handle_error, timeout, retry, simple_cache, abstract, deprecated, silent)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.ctx.html">ctx.py</a>           <span class="comment"># 🔇 Context managers <span class="paren">(LogToFile, MeasureTime, Muffle, DoNothing, SetMPStartMethod)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.io.html">io.py</a>            <span class="comment"># 💾 Utilities for file management <span class="paren">(json_dump, json_load, csv_dump, csv_load, read_file, super_copy, super_open, clean_path, ...)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.parallel.html">parallel.py</a>      <span class="comment"># 🔀 Utility functions for parallel processing <span class="paren">(multiprocessing, multithreading, run_in_subprocess)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.image.html">image.py</a>         <span class="comment"># 🖼️ Little utilities for image processing <span class="paren">(image_resize, auto_crop, numpy_to_gif, numpy_to_obj)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.collections.html">collections.py</a>   <span class="comment"># 🧰 Utilities for collection manipulation <span class="paren">(unique_list, sort_dict_keys, upsert_in_dataframe, array_to_disk)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.all_doctests.html">all_doctests.py</a>  <span class="comment"># ✅ Run all doctests for all modules in a given directory <span class="paren">(launch_tests, test_module_with_progress)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.backup.html">backup.py</a>        <span class="comment"># 💾 Utilities for backup management <span class="paren">(delta backup, consolidate)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.archive.html">archive.py</a>       <span class="comment"># 📦 Functions for creating and managing archives</span>
+│
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.html">applications/</a>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.automatic_docs.html">automatic_docs.py</a>    <span class="comment"># 📚 Documentation generation utilities <span class="paren">(used to create this documentation)</span></span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.upscaler.html">upscaler/</a>            <span class="comment"># 🔎 Image & Video upscaler <span class="paren">(configurable)</span></span>
+│   └── ...
+│
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.html">continuous_delivery/</a>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.cd_utils.html">cd_utils.py</a>          <span class="comment"># 🔧 Utilities for continuous delivery</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.github.html">github.py</a>            <span class="comment"># 📦 Utilities for continuous delivery on GitHub <span class="paren">(upload_to_github)</span></span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.pypi.html">pypi.py</a>              <span class="comment"># 📦 Utilities for PyPI <span class="paren">(pypi_full_routine)</span></span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.pyproject.html">pyproject.py</a>         <span class="comment"># 📝 Utilities for reading, writing and managing pyproject.toml files</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.stubs.html">stubs.py</a>             <span class="comment"># 📝 Utilities for generating stub files using stubgen</span>
+│   └── ...
+│
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.html">data_science/</a>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.config.html">config/</a>              <span class="comment"># ⚙️ Configuration utilities for data science</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.dataset.html">dataset/</a>             <span class="comment"># 📊 Dataset handling <span class="paren">(dataset, dataset_loader, grouping_strategy)</span></span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.data_processing.html">data_processing/</a>     <span class="comment"># 🔄 Data processing utilities <span class="paren">(image augmentation, preprocessing)</span></span>
+│   │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.data_processing.image.html">image/</a>           <span class="comment"># 🖼️ Image processing techniques</span>
+│   │   └── ...
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.html">models/</a>              <span class="comment"># 🧠 ML/DL model interfaces and implementations</span>
+│   │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras.html">keras/</a>           <span class="comment"># 🤖 Keras model implementations</span>
+│   │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras_utils.html">keras_utils/</a>     <span class="comment"># 🛠️ Keras utilities <span class="paren">(callbacks, losses, visualizations)</span></span>
+│   │   └── ...
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.scripts.html">scripts/</a>             <span class="comment"># 📜 Data science scripts <span class="paren">(augment, preprocess, routine)</span></span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.metric_utils.html">metric_utils.py</a>      <span class="comment"># 📏 Static methods for calculating various ML metrics</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.mlflow_utils.html">mlflow_utils.py</a>      <span class="comment"># 📊 Utility functions for working with MLflow</span>
+│   └── ...
+│
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.html">installer/</a>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.common.html">common.py</a>            <span class="comment"># 🔧 Common functions used by the Linux and Windows installers modules</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.downloader.html">downloader.py</a>        <span class="comment"># ⬇️ Functions for downloading and installing programs from URLs</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.linux.html">linux.py</a>             <span class="comment"># 🐧 Linux/macOS specific implementations for installation</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.main.html">main.py</a>              <span class="comment"># 🚀 Core installation functions for installing programs from zip files or URLs</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.windows.html">windows.py</a>           <span class="comment"># 💻 Windows specific implementations for installation</span>
+│   └── ...
+└── ...
+</pre>
+</html>
+## 🔧 Installation
+```bash
+pip install stouputils
+```
+### ✨ Enable Tab Completion on Linux (Optional)
+For a better CLI experience, enable bash tab completion:
+```bash
+# Option 1: Using argcomplete's global activation
+activate-global-python-argcomplete --user
+# Option 2: Manual setup for bash
+register-python-argcomplete stouputils >> ~/.bashrc
+source ~/.bashrc
+```
+After enabling completion, you can use `<TAB>` to autocomplete commands:
+```bash
+stouputils <TAB>        # Shows: --version, -v, all_doctests, backup
+stouputils all_<TAB>    # Completes to: all_doctests
+```
+**Note:** Tab completion works best in bash, zsh, Git Bash, or WSL on Windows.
+## ⭐ Star History
+<html>
+	<a href="https://star-history.com/#Stoupy51/stouputils&Date">
+		<picture>
+			<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date&theme=dark" />
+			<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
+			<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
+		</picture>
+	</a>
+</html>

stouputils-1.15.0/README.md ADDED Viewed

@@ -0,0 +1,136 @@
+## 🛠️ Project Badges
+[![GitHub](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=github&label=GitHub)](https://github.com/Stoupy51/stouputils/releases/latest)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/stouputils?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stouputils/)
+[![Documentation](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=sphinx&label=Documentation&color=purple)](https://stoupy51.github.io/stouputils/latest/)
+## 📚 Project Overview
+Stouputils is a collection of utility modules designed to simplify and enhance the development process.<br>
+It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers.<br>
+Start now by installing the package: `pip install stouputils`.<br>
+<a href="https://colab.research.google.com/drive/1mJ-KL-zXzIk1oKDxO6FC1SFfm-BVKG-P?usp=sharing" target="_blank" rel="noopener noreferrer" style="text-decoration: none;"><div class="admonition">
+📖 <b>Want to see examples?</b> Check out our <u>Google Colab notebook</u> with practical usage examples!
+</div></a>
+## 🚀 Project File Tree
+<html>
+<details style="display: none;">
+<summary></summary>
+<style>
+.code-tree {
+	border-radius: 6px;
+	padding: 16px;
+	font-family: monospace;
+	line-height: 1.45;
+	overflow: auto;
+	white-space: pre;
+	background-color:rgb(43, 43, 43);
+	color: #d4d4d4;
+}
+.code-tree a {
+	color: #569cd6;
+	text-decoration: none;
+}
+.code-tree a:hover {
+	text-decoration: underline;
+}
+.code-tree .comment {
+	color:rgb(231, 213, 48);
+}
+.code-tree .paren {
+	color: orange;
+}
+</style>
+</details>
+<pre class="code-tree">stouputils/
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.print.html">print.py</a>         <span class="comment"># 🖨️ Utility functions for printing <span class="paren">(info, debug, warning, error, whatisit, breakpoint, colored_for_loop, ...)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.decorators.html">decorators.py</a>    <span class="comment"># 🎯 Decorators <span class="paren">(measure_time, handle_error, timeout, retry, simple_cache, abstract, deprecated, silent)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.ctx.html">ctx.py</a>           <span class="comment"># 🔇 Context managers <span class="paren">(LogToFile, MeasureTime, Muffle, DoNothing, SetMPStartMethod)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.io.html">io.py</a>            <span class="comment"># 💾 Utilities for file management <span class="paren">(json_dump, json_load, csv_dump, csv_load, read_file, super_copy, super_open, clean_path, ...)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.parallel.html">parallel.py</a>      <span class="comment"># 🔀 Utility functions for parallel processing <span class="paren">(multiprocessing, multithreading, run_in_subprocess)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.image.html">image.py</a>         <span class="comment"># 🖼️ Little utilities for image processing <span class="paren">(image_resize, auto_crop, numpy_to_gif, numpy_to_obj)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.collections.html">collections.py</a>   <span class="comment"># 🧰 Utilities for collection manipulation <span class="paren">(unique_list, sort_dict_keys, upsert_in_dataframe, array_to_disk)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.all_doctests.html">all_doctests.py</a>  <span class="comment"># ✅ Run all doctests for all modules in a given directory <span class="paren">(launch_tests, test_module_with_progress)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.backup.html">backup.py</a>        <span class="comment"># 💾 Utilities for backup management <span class="paren">(delta backup, consolidate)</span></span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.archive.html">archive.py</a>       <span class="comment"># 📦 Functions for creating and managing archives</span>
+│
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.html">applications/</a>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.automatic_docs.html">automatic_docs.py</a>    <span class="comment"># 📚 Documentation generation utilities <span class="paren">(used to create this documentation)</span></span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.upscaler.html">upscaler/</a>            <span class="comment"># 🔎 Image & Video upscaler <span class="paren">(configurable)</span></span>
+│   └── ...
+│
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.html">continuous_delivery/</a>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.cd_utils.html">cd_utils.py</a>          <span class="comment"># 🔧 Utilities for continuous delivery</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.github.html">github.py</a>            <span class="comment"># 📦 Utilities for continuous delivery on GitHub <span class="paren">(upload_to_github)</span></span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.pypi.html">pypi.py</a>              <span class="comment"># 📦 Utilities for PyPI <span class="paren">(pypi_full_routine)</span></span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.pyproject.html">pyproject.py</a>         <span class="comment"># 📝 Utilities for reading, writing and managing pyproject.toml files</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.stubs.html">stubs.py</a>             <span class="comment"># 📝 Utilities for generating stub files using stubgen</span>
+│   └── ...
+│
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.html">data_science/</a>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.config.html">config/</a>              <span class="comment"># ⚙️ Configuration utilities for data science</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.dataset.html">dataset/</a>             <span class="comment"># 📊 Dataset handling <span class="paren">(dataset, dataset_loader, grouping_strategy)</span></span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.data_processing.html">data_processing/</a>     <span class="comment"># 🔄 Data processing utilities <span class="paren">(image augmentation, preprocessing)</span></span>
+│   │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.data_processing.image.html">image/</a>           <span class="comment"># 🖼️ Image processing techniques</span>
+│   │   └── ...
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.html">models/</a>              <span class="comment"># 🧠 ML/DL model interfaces and implementations</span>
+│   │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras.html">keras/</a>           <span class="comment"># 🤖 Keras model implementations</span>
+│   │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras_utils.html">keras_utils/</a>     <span class="comment"># 🛠️ Keras utilities <span class="paren">(callbacks, losses, visualizations)</span></span>
+│   │   └── ...
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.scripts.html">scripts/</a>             <span class="comment"># 📜 Data science scripts <span class="paren">(augment, preprocess, routine)</span></span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.metric_utils.html">metric_utils.py</a>      <span class="comment"># 📏 Static methods for calculating various ML metrics</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.mlflow_utils.html">mlflow_utils.py</a>      <span class="comment"># 📊 Utility functions for working with MLflow</span>
+│   └── ...
+│
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.html">installer/</a>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.common.html">common.py</a>            <span class="comment"># 🔧 Common functions used by the Linux and Windows installers modules</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.downloader.html">downloader.py</a>        <span class="comment"># ⬇️ Functions for downloading and installing programs from URLs</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.linux.html">linux.py</a>             <span class="comment"># 🐧 Linux/macOS specific implementations for installation</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.main.html">main.py</a>              <span class="comment"># 🚀 Core installation functions for installing programs from zip files or URLs</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.windows.html">windows.py</a>           <span class="comment"># 💻 Windows specific implementations for installation</span>
+│   └── ...
+└── ...
+</pre>
+</html>
+## 🔧 Installation
+```bash
+pip install stouputils
+```
+### ✨ Enable Tab Completion on Linux (Optional)
+For a better CLI experience, enable bash tab completion:
+```bash
+# Option 1: Using argcomplete's global activation
+activate-global-python-argcomplete --user
+# Option 2: Manual setup for bash
+register-python-argcomplete stouputils >> ~/.bashrc
+source ~/.bashrc
+```
+After enabling completion, you can use `<TAB>` to autocomplete commands:
+```bash
+stouputils <TAB>        # Shows: --version, -v, all_doctests, backup
+stouputils all_<TAB>    # Completes to: all_doctests
+```
+**Note:** Tab completion works best in bash, zsh, Git Bash, or WSL on Windows.
+## ⭐ Star History
+<html>
+	<a href="https://star-history.com/#Stoupy51/stouputils&Date">
+		<picture>
+			<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date&theme=dark" />
+			<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
+			<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
+		</picture>
+	</a>
+</html>

stouputils-1.15.0/pyproject.toml ADDED Viewed

@@ -0,0 +1,102 @@
+[build-system]
+requires = ["uv_build"]
+build-backend = "uv_build"
+[tool.uv.build-backend]
+module-root = ""
+[project]
+name = "stouputils"
+version = "1.15.0"
+description = "Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more."
+readme = "README.md"
+keywords = ["utilities", "tools", "helpers", "development", "python"]
+requires-python = ">=3.12"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "tqdm>=4.0.0",
+    "requests>=2.20.0",
+    "msgspec[toml,yaml]>=0.20.0",
+    "pillow>=12.0.0",
+    "python-box>=7.0.0",
+    "argcomplete>=3.0.0",
+    "numpy",
+]
+authors = [
+    { name = "Stoupy51", email = "stoupy51@gmail.com" },
+]
+[project.optional-dependencies]
+docs = [
+    "m2r2",
+    "myst_parser",
+    "sphinx_copybutton",
+    "sphinx_design",
+    "sphinx_treeview",
+    "sphinx_breeze_theme",
+    "pydata_sphinx_theme",
+]
+data_science = [
+    "opencv-python",
+    "scikit-image",
+    "simpleitk",
+    "mlflow",
+    "tensorflow",
+    "scikit-learn",
+    "PyWavelets",
+]
+[project.urls]
+Homepage = "https://stoupy51.github.io/stouputils"
+Issues = "https://github.com/Stoupy51/stouputils/issues"
+Source = "https://github.com/Stoupy51/stouputils"
+[project.scripts]
+stouputils = "stouputils.__main__:main"
+[tool.pyright]
+typeCheckingMode = "strict"
+[tool.ruff]
+exclude = [
+    ".git",
+    ".ruff_cache",
+    ".venv",
+    ".vscode",
+    ".cursor",
+    "build",
+    "dist",
+    "*.pyi",
+]
+line-length = 200
+[tool.ruff.lint]
+select = [
+    "E",
+    "W",
+    "F",
+    "I",
+    "N",
+    "UP",
+    "B",
+    "C4",
+    "T20",
+    "RUF",
+]
+ignore = [
+    "T201",
+    "W191",
+    "N803",
+    "N806",
+    "F403",
+    "F405",
+]

stouputils-1.15.0/stouputils/__init__.py ADDED Viewed

@@ -0,0 +1,40 @@
+""" A collection of utility modules designed to simplify and enhance the development process.
+This package provides various tools and utilities for common development tasks including:
+Key Features:
+- Continuous delivery utilities (GitHub, PyPI)
+- Display and logging utilities (print)
+- File and I/O management (io)
+- Decorators for common patterns
+- Context managers
+- Archive and backup tools
+- Parallel processing helpers
+- Collection utilities
+- Doctests utilities
+"""
+# Version (handle case where the package is not installed)
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version as importlib_version
+# Imports
+from ._deprecated import *
+from .all_doctests import *
+from .archive import *
+from .backup import *
+from .collections import *
+from .continuous_delivery import *
+from .ctx import *
+from .decorators import *
+from .image import *
+from .io import *
+from .parallel import *
+from .print import *
+from .version_pkg import *
+try:
+	__version__: str = importlib_version("stouputils")
+except PackageNotFoundError:
+	__version__: str = "0.0.0-dev"

stouputils-1.0.17/src/stouputils/__init__.py → stouputils-1.15.0/stouputils/__init__.pyi RENAMED Viewed

@@ -1,15 +1,15 @@
-# Imports
-from .print import *
-from .archive import *
-from .io import *
-from .decorators import *
-from .ctx import *
-from .parallel import *
+from ._deprecated import *
 from .all_doctests import *
-from .collections import *
+from .archive import *
 from .backup import *
-# Folders
+from .collections import *
 from .continuous_delivery import *
+from .ctx import *
+from .decorators import *
+from .image import *
+from .io import *
+from .parallel import *
+from .print import *
+from .version_pkg import *
+__version__: str

stouputils-1.15.0/stouputils/__main__.py ADDED Viewed

@@ -0,0 +1,86 @@
+# PYTHON_ARGCOMPLETE_OK
+# Imports
+import argparse
+import sys
+import argcomplete
+from .all_doctests import launch_tests
+from .archive import archive_cli
+from .backup import backup_cli
+from .decorators import handle_error
+from .print import CYAN, GREEN, RESET
+from .version_pkg import show_version_cli
+# Argument Parser Setup for Auto-Completion
+parser = argparse.ArgumentParser(prog="stouputils", add_help=False)
+parser.add_argument("command", nargs="?", choices=[
+	"--version", "-v", "version", "show_version", "all_doctests", "archive", "backup", "build"
+])
+parser.add_argument("args", nargs="*")
+argcomplete.autocomplete(parser)
+@handle_error(message="Error while running 'stouputils'")
+def main() -> None:
+	second_arg: str = sys.argv[1].lower() if len(sys.argv) >= 2 else ""
+	# Print the version of stouputils and its dependencies
+	if second_arg in ("--version", "-v", "version", "show_version"):
+		return show_version_cli()
+	# Handle "all_doctests" command
+	if second_arg == "all_doctests":
+		if launch_tests("." if len(sys.argv) == 2 else sys.argv[2]) > 0:
+			sys.exit(1)
+		return
+	# Handle "archive" command
+	if second_arg == "archive":
+		sys.argv.pop(1)  # Remove "archive" from argv so archive_cli gets clean arguments
+		return archive_cli()
+	# Handle "backup" command
+	if second_arg == "backup":
+		sys.argv.pop(1)  # Remove "backup" from argv so backup_cli gets clean arguments
+		return backup_cli()
+	# Handle "build" command
+	if second_arg == "build":
+		from .continuous_delivery.pypi import pypi_full_routine_using_uv
+		return pypi_full_routine_using_uv()
+	# Check if the command is any package name
+	if second_arg in (): # type: ignore
+		return
+	# Get version
+	from importlib.metadata import version
+	try:
+		pkg_version = version("stouputils")
+	except Exception:
+		pkg_version = "unknown"
+	# Print help with nice formatting
+	separator: str = "─" * 60
+	print(f"""
+{CYAN}{separator}{RESET}
+{CYAN}stouputils {GREEN}CLI {CYAN}v{pkg_version}{RESET}
+{CYAN}{separator}{RESET}
+{CYAN}Usage:{RESET} stouputils <command> [options]
+{CYAN}Available commands:{RESET}
+  {GREEN}--version, -v{RESET} [pkg] [-t <depth>]    Show version information (optionally for a specific package)
+  {GREEN}all_doctests{RESET} [dir]                  Run all doctests in the specified directory
+  {GREEN}archive{RESET} --help                      Archive utilities (make, repair)
+  {GREEN}backup{RESET} --help                       Backup utilities (delta, consolidate, limit)
+  {GREEN}build{RESET} [--no_stubs] [<minor|major>]  Build and publish package to PyPI using 'uv' tool (complete routine)
+{CYAN}{separator}{RESET}
+""".strip())
+	return
+if __name__ == "__main__":
+	main()

stouputils-1.15.0/stouputils/_deprecated.py ADDED Viewed

@@ -0,0 +1,37 @@
+""" Deprecated functions and classes.
+This module contains deprecated functions that have been replaced by new implementations
+These functions are retained for backward compatibility and will log deprecation warnings when used.
+"""
+# Imports
+from typing import Any
+from .decorators import LogLevels, deprecated
+from .io import csv_dump, csv_load, json_dump, json_load
+# Deprecated functions
+@deprecated(message="super_csv_dump has been renamed to csv_dump.", version="v1.8.0", error_log=LogLevels.WARNING)
+def super_csv_dump(*args: Any, **kwargs: Any) -> Any:
+	""" Deprecated function, use "csv_dump" instead. """
+	return csv_dump(*args, **kwargs)
+@deprecated(message="super_csv_load has been renamed to csv_load.", version="v1.8.0", error_log=LogLevels.WARNING)
+def super_csv_load(*args: Any, **kwargs: Any) -> Any:
+	""" Deprecated function, use "csv_load" instead. """
+	return csv_load(*args, **kwargs)
+@deprecated(message="super_json_dump has been renamed to json_dump.", version="v1.8.0", error_log=LogLevels.WARNING)
+def super_json_dump(*args: Any, **kwargs: Any) -> Any:
+	""" Deprecated function, use "json_dump" instead. """
+	return json_dump(*args, **kwargs)
+@deprecated(message="super_json_load has been renamed to json_load.", version="v1.8.0", error_log=LogLevels.WARNING)
+def super_json_load(*args: Any, **kwargs: Any) -> Any:
+	""" Deprecated function, use "json_load" instead. """
+	return json_load(*args, **kwargs)

stouputils-1.15.0/stouputils/_deprecated.pyi ADDED Viewed

@@ -0,0 +1,12 @@
+from .decorators import LogLevels as LogLevels, deprecated as deprecated
+from .io import csv_dump as csv_dump, csv_load as csv_load, json_dump as json_dump, json_load as json_load
+from typing import Any
+def super_csv_dump(*args: Any, **kwargs: Any) -> Any:
+    ''' Deprecated function, use "csv_dump" instead. '''
+def super_csv_load(*args: Any, **kwargs: Any) -> Any:
+    ''' Deprecated function, use "csv_load" instead. '''
+def super_json_dump(*args: Any, **kwargs: Any) -> Any:
+    ''' Deprecated function, use "json_dump" instead. '''
+def super_json_load(*args: Any, **kwargs: Any) -> Any:
+    ''' Deprecated function, use "json_load" instead. '''

stouputils 1.0.17__tar.gz → 1.15.0__tar.gz

stouputils 1.0.17tar.gz → 1.15.0tar.gz