stouputils 1.3.21__tar.gz → 1.9.0__tar.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 (143) hide show
  1. {stouputils-1.3.21 → stouputils-1.9.0}/.gitignore +5 -0
  2. stouputils-1.3.21/README.md → stouputils-1.9.0/PKG-INFO +172 -102
  3. stouputils-1.3.21/PKG-INFO → stouputils-1.9.0/README.md +130 -126
  4. {stouputils-1.3.21 → stouputils-1.9.0}/pyproject.toml +26 -2
  5. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/__init__.py +6 -7
  6. stouputils-1.9.0/stouputils/__init__.pyi +14 -0
  7. stouputils-1.9.0/stouputils/__main__.py +67 -0
  8. stouputils-1.9.0/stouputils/_deprecated.py +37 -0
  9. stouputils-1.9.0/stouputils/_deprecated.pyi +12 -0
  10. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/all_doctests.py +40 -17
  11. stouputils-1.9.0/stouputils/all_doctests.pyi +46 -0
  12. stouputils-1.9.0/stouputils/applications/__init__.pyi +2 -0
  13. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/applications/automatic_docs.py +104 -39
  14. stouputils-1.9.0/stouputils/applications/automatic_docs.pyi +106 -0
  15. stouputils-1.9.0/stouputils/applications/upscaler/__init__.pyi +3 -0
  16. stouputils-1.9.0/stouputils/applications/upscaler/config.pyi +18 -0
  17. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/applications/upscaler/image.py +2 -2
  18. stouputils-1.9.0/stouputils/applications/upscaler/image.pyi +109 -0
  19. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/applications/upscaler/video.py +4 -3
  20. stouputils-1.9.0/stouputils/applications/upscaler/video.pyi +60 -0
  21. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/archive.py +132 -113
  22. stouputils-1.9.0/stouputils/archive.pyi +67 -0
  23. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/backup.py +230 -115
  24. stouputils-1.9.0/stouputils/backup.pyi +109 -0
  25. stouputils-1.9.0/stouputils/collections.py +240 -0
  26. stouputils-1.9.0/stouputils/collections.pyi +85 -0
  27. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/continuous_delivery/__init__.py +2 -0
  28. stouputils-1.9.0/stouputils/continuous_delivery/__init__.pyi +5 -0
  29. stouputils-1.9.0/stouputils/continuous_delivery/cd_utils.py +236 -0
  30. stouputils-1.9.0/stouputils/continuous_delivery/cd_utils.pyi +128 -0
  31. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/continuous_delivery/github.py +36 -8
  32. stouputils-1.9.0/stouputils/continuous_delivery/github.pyi +162 -0
  33. stouputils-1.9.0/stouputils/continuous_delivery/pypi.pyi +43 -0
  34. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/continuous_delivery/pyproject.py +2 -2
  35. stouputils-1.9.0/stouputils/continuous_delivery/pyproject.pyi +47 -0
  36. stouputils-1.9.0/stouputils/continuous_delivery/stubs.py +83 -0
  37. stouputils-1.9.0/stouputils/continuous_delivery/stubs.pyi +39 -0
  38. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/ctx.py +87 -45
  39. stouputils-1.9.0/stouputils/ctx.pyi +143 -0
  40. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/metric_utils.py +847 -847
  41. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/base_keras.py +765 -766
  42. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/model_interface.py +939 -939
  43. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/scripts/augment_dataset.py +77 -77
  44. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/scripts/exhaustive_process.py +133 -133
  45. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/scripts/preprocess_dataset.py +70 -70
  46. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/scripts/routine.py +168 -168
  47. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/decorators.py +210 -117
  48. stouputils-1.9.0/stouputils/decorators.pyi +208 -0
  49. stouputils-1.9.0/stouputils/image.py +426 -0
  50. stouputils-1.9.0/stouputils/image.pyi +163 -0
  51. stouputils-1.9.0/stouputils/installer/__init__.pyi +5 -0
  52. stouputils-1.9.0/stouputils/installer/common.pyi +39 -0
  53. stouputils-1.9.0/stouputils/installer/downloader.pyi +24 -0
  54. stouputils-1.9.0/stouputils/installer/linux.pyi +39 -0
  55. stouputils-1.9.0/stouputils/installer/main.pyi +57 -0
  56. stouputils-1.9.0/stouputils/installer/windows.pyi +31 -0
  57. stouputils-1.9.0/stouputils/io.py +493 -0
  58. stouputils-1.9.0/stouputils/io.pyi +208 -0
  59. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/parallel.py +83 -93
  60. stouputils-1.9.0/stouputils/parallel.pyi +144 -0
  61. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/print.py +192 -46
  62. stouputils-1.9.0/stouputils/print.pyi +146 -0
  63. stouputils-1.3.21/stouputils/collections.py +0 -62
  64. stouputils-1.3.21/stouputils/continuous_delivery/cd_utils.py +0 -141
  65. stouputils-1.3.21/stouputils/image.py +0 -88
  66. stouputils-1.3.21/stouputils/io.py +0 -287
  67. {stouputils-1.3.21 → stouputils-1.9.0}/LICENSE +0 -0
  68. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/applications/__init__.py +0 -0
  69. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/applications/upscaler/__init__.py +0 -0
  70. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/applications/upscaler/config.py +0 -0
  71. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/continuous_delivery/pypi.py +0 -0
  72. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/config/get.py +0 -0
  73. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/config/set.py +0 -0
  74. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/__init__.py +0 -0
  75. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/auto_contrast.py +0 -0
  76. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/axis_flip.py +0 -0
  77. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/bias_field_correction.py +0 -0
  78. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/binary_threshold.py +0 -0
  79. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/blur.py +0 -0
  80. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/brightness.py +0 -0
  81. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/canny.py +0 -0
  82. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/clahe.py +0 -0
  83. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/common.py +0 -0
  84. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/contrast.py +0 -0
  85. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/curvature_flow_filter.py +0 -0
  86. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/denoise.py +0 -0
  87. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/histogram_equalization.py +0 -0
  88. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/invert.py +0 -0
  89. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/laplacian.py +0 -0
  90. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/median_blur.py +0 -0
  91. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/noise.py +0 -0
  92. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/normalize.py +0 -0
  93. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/random_erase.py +0 -0
  94. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/resize.py +0 -0
  95. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/rotation.py +0 -0
  96. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/salt_pepper.py +0 -0
  97. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/sharpening.py +0 -0
  98. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/shearing.py +0 -0
  99. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/threshold.py +0 -0
  100. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/translation.py +0 -0
  101. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image/zoom.py +0 -0
  102. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image_augmentation.py +0 -0
  103. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/image_preprocess.py +0 -0
  104. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/prosthesis_detection.py +0 -0
  105. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/data_processing/technique.py +0 -0
  106. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/dataset/__init__.py +0 -0
  107. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/dataset/dataset.py +0 -0
  108. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/dataset/dataset_loader.py +0 -0
  109. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/dataset/grouping_strategy.py +0 -0
  110. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/dataset/image_loader.py +0 -0
  111. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/dataset/xy_tuple.py +0 -0
  112. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/metric_dictionnary.py +0 -0
  113. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/mlflow_utils.py +0 -0
  114. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/abstract_model.py +0 -0
  115. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/all.py +0 -0
  116. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras/all.py +0 -0
  117. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras/convnext.py +0 -0
  118. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras/densenet.py +0 -0
  119. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras/efficientnet.py +0 -0
  120. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras/mobilenet.py +0 -0
  121. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras/resnet.py +0 -0
  122. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras/squeezenet.py +0 -0
  123. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras/vgg.py +0 -0
  124. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras/xception.py +0 -0
  125. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras_utils/callbacks/__init__.py +0 -0
  126. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras_utils/callbacks/colored_progress_bar.py +0 -0
  127. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras_utils/callbacks/learning_rate_finder.py +0 -0
  128. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras_utils/callbacks/model_checkpoint_v2.py +0 -0
  129. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras_utils/callbacks/progressive_unfreezing.py +0 -0
  130. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras_utils/callbacks/warmup_scheduler.py +0 -0
  131. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras_utils/losses/__init__.py +0 -0
  132. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras_utils/losses/next_generation_loss.py +0 -0
  133. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/keras_utils/visualizations.py +0 -0
  134. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/models/sandbox.py +0 -0
  135. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/range_tuple.py +0 -0
  136. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/data_science/utils.py +0 -0
  137. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/installer/__init__.py +0 -0
  138. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/installer/common.py +0 -0
  139. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/installer/downloader.py +0 -0
  140. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/installer/linux.py +0 -0
  141. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/installer/main.py +0 -0
  142. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/installer/windows.py +0 -0
  143. {stouputils-1.3.21 → stouputils-1.9.0}/stouputils/py.typed +0 -0
@@ -1,11 +1,16 @@
1
1
 
2
2
  # Python
3
3
  *__pycache__/
4
+ uv.lock
4
5
 
5
6
  # Miscellaneous
6
7
  __temporary__/
7
8
  output.log
8
9
  logfile.txt
10
+ .vscode
11
+
12
+ # Type stubs
13
+ *.pyi
9
14
 
10
15
  # Documentation
11
16
  docs/source/_static/
@@ -1,102 +1,172 @@
1
- # 🛠️ Project Badges
2
- [![GitHub](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=github&label=GitHub)](https://github.com/Stoupy51/stouputils/releases/latest)
3
- [![PyPI - Downloads](https://img.shields.io/pypi/dm/stouputils?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stouputils/)
4
- [![Documentation](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=sphinx&label=Documentation&color=purple)](https://stoupy51.github.io/stouputils/latest/)
5
-
6
- <br>
7
-
8
- # 📚 Project Overview
9
- Stouputils is a collection of utility modules designed to simplify and enhance the development process.<br>
10
- It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers.
11
-
12
-
13
- # 🚀 Project File Tree
14
- <html>
15
- <details style="display: none;">
16
- <summary></summary>
17
- <style>
18
- .code-tree {
19
- border-radius: 6px;
20
- padding: 16px;
21
- font-family: monospace;
22
- line-height: 1.45;
23
- overflow: auto;
24
- white-space: pre;
25
- background-color:rgb(43, 43, 43);
26
- color: #d4d4d4;
27
- }
28
- .code-tree a {
29
- color: #569cd6;
30
- text-decoration: none;
31
- }
32
- .code-tree a:hover {
33
- text-decoration: underline;
34
- }
35
- .code-tree .comment {
36
- color:rgb(231, 213, 48);
37
- }
38
- </style>
39
- </details>
40
-
41
- <pre class="code-tree">stouputils/
42
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.html">applications/</a>
43
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.automatic_docs.html">automatic_docs.py</a> <span class="comment"># 📚 Documentation generation utilities (used to create this documentation)</span>
44
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.upscaler.html">upscaler/</a> <span class="comment"># 🔎 Image & Video upscaler (configurable)</span>
45
- │ └── ...
46
-
47
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.html">continuous_delivery/</a>
48
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.cd_utils.html">cd_utils.py</a> <span class="comment"># 🔧 Common utilities for continuous delivery</span>
49
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.github.html">github.py</a> <span class="comment"># 📦 GitHub utilities (upload_to_github)</span>
50
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.pypi.html">pypi.py</a> <span class="comment"># 📦 PyPI utilities (pypi_full_routine)</span>
51
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.pyproject.html">pyproject.py</a> <span class="comment"># 📝 Pyproject.toml utilities</span>
52
- │ └── ...
53
-
54
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.html">data_science/</a>
55
- │ ├── <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>
56
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.dataset.html">dataset/</a> <span class="comment"># 📊 Dataset handling (dataset, dataset_loader, grouping_strategy)</span>
57
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.data_processing.html">data_processing/</a> <span class="comment"># 🔄 Data processing utilities (image augmentation, preprocessing)</span>
58
- │ │ ├── <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>
59
- │ │ └── ...
60
- │ ├── <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>
61
- │ │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras.html">keras/</a> <span class="comment"># 🤖 Keras model implementations</span>
62
- │ │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras_utils.html">keras_utils/</a> <span class="comment"># 🛠️ Keras utilities (callbacks, losses, visualizations)</span>
63
- │ │ └── ...
64
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.scripts.html">scripts/</a> <span class="comment"># 📜 Data science scripts (augment, preprocess, routine)</span>
65
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.metric_utils.html">metric_utils.py</a> <span class="comment"># 📏 Metrics utilities for ML/DL models</span>
66
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.mlflow_utils.html">mlflow_utils.py</a> <span class="comment"># 📊 MLflow integration utilities</span>
67
- │ └── ...
68
-
69
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.html">installer/</a>
70
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.common.html">common.py</a> <span class="comment"># 🔧 Common installer utilities</span>
71
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.downloader.html">downloader.py</a> <span class="comment"># ⬇️ File download utilities</span>
72
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.linux.html">linux.py</a> <span class="comment"># 🐧 Linux-specific installer utilities</span>
73
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.main.html">main.py</a> <span class="comment"># 🚀 Main installer functionality</span>
74
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.windows.html">windows.py</a> <span class="comment"># 💻 Windows-specific installer utilities</span>
75
- │ └── ...
76
-
77
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.all_doctests.html">all_doctests.py</a> <span class="comment"># ✅ Execution of all doctests for a given path</span>
78
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.archive.html">archive.py</a> <span class="comment"># 📦 Archive utilities (zip, repair_zip)</span>
79
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.backup.html">backup.py</a> <span class="comment"># 📦 Backup utilities (delta backup, consolidate)</span>
80
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.collections.html">collections.py</a> <span class="comment"># 🧰 Collection utilities (unique_list)</span>
81
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.ctx.html">ctx.py</a> <span class="comment"># 🚫 Context managers (Muffle, LogToFile)</span>
82
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.decorators.html">decorators.py</a> <span class="comment"># 🎯 Decorators (silent, measure_time, error_handler, simple_cache)</span>
83
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.image.html">image.py</a> <span class="comment"># 🖼️ Image utilities (image_resize)</span>
84
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.io.html">io.py</a> <span class="comment"># 💻 I/O utilities (file management, json)</span>
85
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.parallel.html">parallel.py</a> <span class="comment"># 🧑‍🤝‍🧑 Parallel processing (multiprocessing, multithreading)</span>
86
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.print.html">print.py</a> <span class="comment"># 🖨️ Display utilities (info, debug, warning, error)</span>
87
- └── ...
88
- </pre>
89
- </html>
90
-
91
- ## Star History
92
-
93
- <html>
94
- <a href="https://star-history.com/#Stoupy51/stouputils&Date">
95
- <picture>
96
- <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date&theme=dark" />
97
- <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
98
- <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
99
- </picture>
100
- </a>
101
- </html>
102
-
1
+ Metadata-Version: 2.4
2
+ Name: stouputils
3
+ Version: 1.9.0
4
+ 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.
5
+ Project-URL: Homepage, https://github.com/Stoupy51/stouputils
6
+ Project-URL: Issues, https://github.com/Stoupy51/stouputils/issues
7
+ Author-email: Stoupy51 <stoupy51@gmail.com>
8
+ License-File: LICENSE
9
+ Classifier: License :: OSI Approved :: MIT License
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Programming Language :: Python :: 3
12
+ Requires-Python: >=3.10
13
+ Requires-Dist: argcomplete>=3.0.0
14
+ Requires-Dist: mypy>=1.18.2
15
+ Requires-Dist: numpy
16
+ Requires-Dist: opencv-python>=4.0.0
17
+ Requires-Dist: orjson>=3.0.0
18
+ Requires-Dist: pillow>=10.0.0
19
+ Requires-Dist: pyfastcopy>=1.0.0
20
+ Requires-Dist: python-box[all]>=7.0.0
21
+ Requires-Dist: pyyaml>=6.0.0
22
+ Requires-Dist: requests>=2.20.0
23
+ Requires-Dist: toml>=0.10.0
24
+ Requires-Dist: tqdm>=4.0.0
25
+ Requires-Dist: zarr>=2.18.3
26
+ Provides-Extra: data-science
27
+ Requires-Dist: mlflow; extra == 'data-science'
28
+ Requires-Dist: pywavelets; extra == 'data-science'
29
+ Requires-Dist: scikit-image; extra == 'data-science'
30
+ Requires-Dist: scikit-learn; extra == 'data-science'
31
+ Requires-Dist: simpleitk; extra == 'data-science'
32
+ Requires-Dist: tensorflow; extra == 'data-science'
33
+ Provides-Extra: docs
34
+ Requires-Dist: m2r2; extra == 'docs'
35
+ Requires-Dist: myst-parser; extra == 'docs'
36
+ Requires-Dist: pydata-sphinx-theme; extra == 'docs'
37
+ Requires-Dist: sphinx-breeze-theme; extra == 'docs'
38
+ Requires-Dist: sphinx-copybutton; extra == 'docs'
39
+ Requires-Dist: sphinx-design; extra == 'docs'
40
+ Requires-Dist: sphinx-treeview; extra == 'docs'
41
+ Description-Content-Type: text/markdown
42
+
43
+ # 🛠️ Project Badges
44
+ [![GitHub](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=github&label=GitHub)](https://github.com/Stoupy51/stouputils/releases/latest)
45
+ [![PyPI - Downloads](https://img.shields.io/pypi/dm/stouputils?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stouputils/)
46
+ [![Documentation](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=sphinx&label=Documentation&color=purple)](https://stoupy51.github.io/stouputils/latest/)
47
+
48
+ <br>
49
+
50
+ # 📚 Project Overview
51
+ Stouputils is a collection of utility modules designed to simplify and enhance the development process.<br>
52
+ It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers.
53
+
54
+ ## 🔧 Installation
55
+
56
+ ```bash
57
+ pip install stouputils
58
+ ```
59
+
60
+ ### Enable Tab Completion on Linux (Optional)
61
+
62
+ For a better CLI experience, enable bash tab completion:
63
+
64
+ ```bash
65
+ # Option 1: Using argcomplete's global activation
66
+ activate-global-python-argcomplete --user
67
+
68
+ # Option 2: Manual setup for bash
69
+ register-python-argcomplete stouputils >> ~/.bashrc
70
+ source ~/.bashrc
71
+ ```
72
+
73
+ After enabling completion, you can use `<TAB>` to autocomplete commands:
74
+ ```bash
75
+ stouputils <TAB> # Shows: --version, -v, all_doctests, backup
76
+ stouputils all_<TAB> # Completes to: all_doctests
77
+ ```
78
+
79
+ **Note:** Tab completion works best in bash, zsh, Git Bash, or WSL on Windows.
80
+
81
+
82
+ # 🚀 Project File Tree
83
+ <html>
84
+ <details style="display: none;">
85
+ <summary></summary>
86
+ <style>
87
+ .code-tree {
88
+ border-radius: 6px;
89
+ padding: 16px;
90
+ font-family: monospace;
91
+ line-height: 1.45;
92
+ overflow: auto;
93
+ white-space: pre;
94
+ background-color:rgb(43, 43, 43);
95
+ color: #d4d4d4;
96
+ }
97
+ .code-tree a {
98
+ color: #569cd6;
99
+ text-decoration: none;
100
+ }
101
+ .code-tree a:hover {
102
+ text-decoration: underline;
103
+ }
104
+ .code-tree .comment {
105
+ color:rgb(231, 213, 48);
106
+ }
107
+ </style>
108
+ </details>
109
+
110
+ <pre class="code-tree">stouputils/
111
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.html">applications/</a>
112
+ │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.automatic_docs.html">automatic_docs.py</a> <span class="comment"># 📚 Documentation generation utilities (used to create this documentation)</span>
113
+ │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.upscaler.html">upscaler/</a> <span class="comment"># 🔎 Image & Video upscaler (configurable)</span>
114
+ │ └── ...
115
+
116
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.html">continuous_delivery/</a>
117
+ │ ├── <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>
118
+ │ ├── <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 (upload_to_github)</span>
119
+ │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.pypi.html">pypi.py</a> <span class="comment"># 📦 Utilities for PyPI (pypi_full_routine)</span>
120
+ │ ├── <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>
121
+ │ ├── <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>
122
+ │ └── ...
123
+
124
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.html">data_science/</a>
125
+ │ ├── <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>
126
+ │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.dataset.html">dataset/</a> <span class="comment"># 📊 Dataset handling (dataset, dataset_loader, grouping_strategy)</span>
127
+ │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.data_processing.html">data_processing/</a> <span class="comment"># 🔄 Data processing utilities (image augmentation, preprocessing)</span>
128
+ │ │ ├── <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>
129
+ │ │ └── ...
130
+ │ ├── <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>
131
+ │ │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras.html">keras/</a> <span class="comment"># 🤖 Keras model implementations</span>
132
+ │ │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras_utils.html">keras_utils/</a> <span class="comment"># 🛠️ Keras utilities (callbacks, losses, visualizations)</span>
133
+ │ │ └── ...
134
+ │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.scripts.html">scripts/</a> <span class="comment"># 📜 Data science scripts (augment, preprocess, routine)</span>
135
+ │ ├── <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>
136
+ │ ├── <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>
137
+ │ └── ...
138
+
139
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.html">installer/</a>
140
+ │ ├── <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>
141
+ │ ├── <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>
142
+ │ ├── <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>
143
+ │ ├── <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>
144
+ │ ├── <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>
145
+ │ └── ...
146
+
147
+ ├── <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>
148
+ ├── <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>
149
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.backup.html">backup.py</a> <span class="comment"># 💾 Utilities for backup management (delta backup, consolidate)</span>
150
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.collections.html">collections.py</a> <span class="comment"># 🧰 Utilities for collection manipulation (unique_list, sort_dict_keys, upsert_in_dataframe, array_to_disk)</span>
151
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.ctx.html">ctx.py</a> <span class="comment"># 🔇 Context managers (Muffle, LogToFile, MeasureTime, DoNothing)</span>
152
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.decorators.html">decorators.py</a> <span class="comment"># 🎯 Decorators (measure_time, handle_error, simple_cache, retry, abstract, deprecated, silent)</span>
153
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.image.html">image.py</a> <span class="comment"># 🖼️ Little utilities for image processing (image_resize, auto_crop, numpy_to_gif, numpy_to_obj)</span>
154
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.io.html">io.py</a> <span class="comment"># 💾 Utilities for file management (super_json, super_csv, super_copy, super_open, clean_path)</span>
155
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.parallel.html">parallel.py</a> <span class="comment"># 🔀 Utility functions for parallel processing (multiprocessing, multithreading)</span>
156
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.print.html">print.py</a> <span class="comment"># 🖨️ Utility functions for printing messages with different levels of importance</span>
157
+ └── ...
158
+ </pre>
159
+ </html>
160
+
161
+ ## ⭐ Star History
162
+
163
+ <html>
164
+ <a href="https://star-history.com/#Stoupy51/stouputils&Date">
165
+ <picture>
166
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date&theme=dark" />
167
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
168
+ <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
169
+ </picture>
170
+ </a>
171
+ </html>
172
+
@@ -1,126 +1,130 @@
1
- Metadata-Version: 2.4
2
- Name: stouputils
3
- Version: 1.3.21
4
- 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.
5
- Project-URL: Homepage, https://github.com/Stoupy51/stouputils
6
- Project-URL: Issues, https://github.com/Stoupy51/stouputils/issues
7
- Author-email: Stoupy51 <stoupy51@gmail.com>
8
- License-File: LICENSE
9
- Classifier: License :: OSI Approved :: MIT License
10
- Classifier: Operating System :: OS Independent
11
- Classifier: Programming Language :: Python :: 3
12
- Requires-Python: >=3.10
13
- Requires-Dist: numpy
14
- Requires-Dist: opencv-python>=4.0.0
15
- Requires-Dist: orjson>=3.0.0
16
- Requires-Dist: pillow>=10.0.0
17
- Requires-Dist: pyfastcopy>=1.0.0
18
- Requires-Dist: python-box[all]>=7.0.0
19
- Requires-Dist: pyyaml>=6.0.0
20
- Requires-Dist: requests>=2.20.0
21
- Requires-Dist: toml>=0.10.0
22
- Requires-Dist: tqdm>=4.0.0
23
- Description-Content-Type: text/markdown
24
-
25
- # 🛠️ Project Badges
26
- [![GitHub](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=github&label=GitHub)](https://github.com/Stoupy51/stouputils/releases/latest)
27
- [![PyPI - Downloads](https://img.shields.io/pypi/dm/stouputils?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stouputils/)
28
- [![Documentation](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=sphinx&label=Documentation&color=purple)](https://stoupy51.github.io/stouputils/latest/)
29
-
30
- <br>
31
-
32
- # 📚 Project Overview
33
- Stouputils is a collection of utility modules designed to simplify and enhance the development process.<br>
34
- It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers.
35
-
36
-
37
- # 🚀 Project File Tree
38
- <html>
39
- <details style="display: none;">
40
- <summary></summary>
41
- <style>
42
- .code-tree {
43
- border-radius: 6px;
44
- padding: 16px;
45
- font-family: monospace;
46
- line-height: 1.45;
47
- overflow: auto;
48
- white-space: pre;
49
- background-color:rgb(43, 43, 43);
50
- color: #d4d4d4;
51
- }
52
- .code-tree a {
53
- color: #569cd6;
54
- text-decoration: none;
55
- }
56
- .code-tree a:hover {
57
- text-decoration: underline;
58
- }
59
- .code-tree .comment {
60
- color:rgb(231, 213, 48);
61
- }
62
- </style>
63
- </details>
64
-
65
- <pre class="code-tree">stouputils/
66
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.html">applications/</a>
67
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.automatic_docs.html">automatic_docs.py</a> <span class="comment"># 📚 Documentation generation utilities (used to create this documentation)</span>
68
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.upscaler.html">upscaler/</a> <span class="comment"># 🔎 Image & Video upscaler (configurable)</span>
69
- │ └── ...
70
-
71
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.html">continuous_delivery/</a>
72
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.cd_utils.html">cd_utils.py</a> <span class="comment"># 🔧 Common utilities for continuous delivery</span>
73
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.github.html">github.py</a> <span class="comment"># 📦 GitHub utilities (upload_to_github)</span>
74
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.pypi.html">pypi.py</a> <span class="comment"># 📦 PyPI utilities (pypi_full_routine)</span>
75
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.pyproject.html">pyproject.py</a> <span class="comment"># 📝 Pyproject.toml utilities</span>
76
- └── ...
77
-
78
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.html">data_science/</a>
79
- │ ├── <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>
80
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.dataset.html">dataset/</a> <span class="comment"># 📊 Dataset handling (dataset, dataset_loader, grouping_strategy)</span>
81
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.data_processing.html">data_processing/</a> <span class="comment"># 🔄 Data processing utilities (image augmentation, preprocessing)</span>
82
- │ │ ├── <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>
83
- │ └── ...
84
- │ ├── <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>
85
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras.html">keras/</a> <span class="comment"># 🤖 Keras model implementations</span>
86
- │ │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras_utils.html">keras_utils/</a> <span class="comment"># 🛠️ Keras utilities (callbacks, losses, visualizations)</span>
87
- │ │ └── ...
88
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.scripts.html">scripts/</a> <span class="comment"># 📜 Data science scripts (augment, preprocess, routine)</span>
89
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.metric_utils.html">metric_utils.py</a> <span class="comment"># 📏 Metrics utilities for ML/DL models</span>
90
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.mlflow_utils.html">mlflow_utils.py</a> <span class="comment"># 📊 MLflow integration utilities</span>
91
- │ └── ...
92
-
93
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.html">installer/</a>
94
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.common.html">common.py</a> <span class="comment"># 🔧 Common installer utilities</span>
95
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.downloader.html">downloader.py</a> <span class="comment"># ⬇️ File download utilities</span>
96
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.linux.html">linux.py</a> <span class="comment"># 🐧 Linux-specific installer utilities</span>
97
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.main.html">main.py</a> <span class="comment"># 🚀 Main installer functionality</span>
98
- │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.windows.html">windows.py</a> <span class="comment"># 💻 Windows-specific installer utilities</span>
99
- └── ...
100
-
101
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.all_doctests.html">all_doctests.py</a> <span class="comment"># Execution of all doctests for a given path</span>
102
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.archive.html">archive.py</a> <span class="comment"># 📦 Archive utilities (zip, repair_zip)</span>
103
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.backup.html">backup.py</a> <span class="comment"># 📦 Backup utilities (delta backup, consolidate)</span>
104
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.collections.html">collections.py</a> <span class="comment"># 🧰 Collection utilities (unique_list)</span>
105
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.ctx.html">ctx.py</a> <span class="comment"># 🚫 Context managers (Muffle, LogToFile)</span>
106
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.decorators.html">decorators.py</a> <span class="comment"># 🎯 Decorators (silent, measure_time, error_handler, simple_cache)</span>
107
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.image.html">image.py</a> <span class="comment"># 🖼️ Image utilities (image_resize)</span>
108
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.io.html">io.py</a> <span class="comment"># 💻 I/O utilities (file management, json)</span>
109
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.parallel.html">parallel.py</a> <span class="comment"># 🧑‍🤝‍🧑 Parallel processing (multiprocessing, multithreading)</span>
110
- ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.print.html">print.py</a> <span class="comment"># 🖨️ Display utilities (info, debug, warning, error)</span>
111
- └── ...
112
- </pre>
113
- </html>
114
-
115
- ## ⭐ Star History
116
-
117
- <html>
118
- <a href="https://star-history.com/#Stoupy51/stouputils&Date">
119
- <picture>
120
- <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date&theme=dark" />
121
- <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
122
- <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
123
- </picture>
124
- </a>
125
- </html>
126
-
1
+ # 🛠️ Project Badges
2
+ [![GitHub](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=github&label=GitHub)](https://github.com/Stoupy51/stouputils/releases/latest)
3
+ [![PyPI - Downloads](https://img.shields.io/pypi/dm/stouputils?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stouputils/)
4
+ [![Documentation](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=sphinx&label=Documentation&color=purple)](https://stoupy51.github.io/stouputils/latest/)
5
+
6
+ <br>
7
+
8
+ # 📚 Project Overview
9
+ Stouputils is a collection of utility modules designed to simplify and enhance the development process.<br>
10
+ It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers.
11
+
12
+ ## 🔧 Installation
13
+
14
+ ```bash
15
+ pip install stouputils
16
+ ```
17
+
18
+ ### ✨ Enable Tab Completion on Linux (Optional)
19
+
20
+ For a better CLI experience, enable bash tab completion:
21
+
22
+ ```bash
23
+ # Option 1: Using argcomplete's global activation
24
+ activate-global-python-argcomplete --user
25
+
26
+ # Option 2: Manual setup for bash
27
+ register-python-argcomplete stouputils >> ~/.bashrc
28
+ source ~/.bashrc
29
+ ```
30
+
31
+ After enabling completion, you can use `<TAB>` to autocomplete commands:
32
+ ```bash
33
+ stouputils <TAB> # Shows: --version, -v, all_doctests, backup
34
+ stouputils all_<TAB> # Completes to: all_doctests
35
+ ```
36
+
37
+ **Note:** Tab completion works best in bash, zsh, Git Bash, or WSL on Windows.
38
+
39
+
40
+ # 🚀 Project File Tree
41
+ <html>
42
+ <details style="display: none;">
43
+ <summary></summary>
44
+ <style>
45
+ .code-tree {
46
+ border-radius: 6px;
47
+ padding: 16px;
48
+ font-family: monospace;
49
+ line-height: 1.45;
50
+ overflow: auto;
51
+ white-space: pre;
52
+ background-color:rgb(43, 43, 43);
53
+ color: #d4d4d4;
54
+ }
55
+ .code-tree a {
56
+ color: #569cd6;
57
+ text-decoration: none;
58
+ }
59
+ .code-tree a:hover {
60
+ text-decoration: underline;
61
+ }
62
+ .code-tree .comment {
63
+ color:rgb(231, 213, 48);
64
+ }
65
+ </style>
66
+ </details>
67
+
68
+ <pre class="code-tree">stouputils/
69
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.html">applications/</a>
70
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.automatic_docs.html">automatic_docs.py</a> <span class="comment"># 📚 Documentation generation utilities (used to create this documentation)</span>
71
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.upscaler.html">upscaler/</a> <span class="comment"># 🔎 Image & Video upscaler (configurable)</span>
72
+ └── ...
73
+
74
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.html">continuous_delivery/</a>
75
+ │ ├── <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>
76
+ ├── <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 (upload_to_github)</span>
77
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.pypi.html">pypi.py</a> <span class="comment"># 📦 Utilities for PyPI (pypi_full_routine)</span>
78
+ ├── <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>
79
+ │ ├── <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>
80
+ └── ...
81
+
82
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.html">data_science/</a>
83
+ ├── <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>
84
+ │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.dataset.html">dataset/</a> <span class="comment"># 📊 Dataset handling (dataset, dataset_loader, grouping_strategy)</span>
85
+ │ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.data_processing.html">data_processing/</a> <span class="comment"># 🔄 Data processing utilities (image augmentation, preprocessing)</span>
86
+ │ │ ├── <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>
87
+ │ │ └── ...
88
+ │ ├── <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>
89
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras.html">keras/</a> <span class="comment"># 🤖 Keras model implementations</span>
90
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras_utils.html">keras_utils/</a> <span class="comment"># 🛠️ Keras utilities (callbacks, losses, visualizations)</span>
91
+ └── ...
92
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.scripts.html">scripts/</a> <span class="comment"># 📜 Data science scripts (augment, preprocess, routine)</span>
93
+ ├── <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>
94
+ │ ├── <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>
95
+ └── ...
96
+
97
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.html">installer/</a>
98
+ │ ├── <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>
99
+ ├── <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>
100
+ ├── <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>
101
+ ├── <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>
102
+ ├── <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>
103
+ │ └── ...
104
+
105
+ ├── <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>
106
+ ├── <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>
107
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.backup.html">backup.py</a> <span class="comment"># 💾 Utilities for backup management (delta backup, consolidate)</span>
108
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.collections.html">collections.py</a> <span class="comment"># 🧰 Utilities for collection manipulation (unique_list, sort_dict_keys, upsert_in_dataframe, array_to_disk)</span>
109
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.ctx.html">ctx.py</a> <span class="comment"># 🔇 Context managers (Muffle, LogToFile, MeasureTime, DoNothing)</span>
110
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.decorators.html">decorators.py</a> <span class="comment"># 🎯 Decorators (measure_time, handle_error, simple_cache, retry, abstract, deprecated, silent)</span>
111
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.image.html">image.py</a> <span class="comment"># 🖼️ Little utilities for image processing (image_resize, auto_crop, numpy_to_gif, numpy_to_obj)</span>
112
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.io.html">io.py</a> <span class="comment"># 💾 Utilities for file management (super_json, super_csv, super_copy, super_open, clean_path)</span>
113
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.parallel.html">parallel.py</a> <span class="comment"># 🔀 Utility functions for parallel processing (multiprocessing, multithreading)</span>
114
+ ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.print.html">print.py</a> <span class="comment"># 🖨️ Utility functions for printing messages with different levels of importance</span>
115
+ └── ...
116
+ </pre>
117
+ </html>
118
+
119
+ ## ⭐ Star History
120
+
121
+ <html>
122
+ <a href="https://star-history.com/#Stoupy51/stouputils&Date">
123
+ <picture>
124
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date&theme=dark" />
125
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
126
+ <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
127
+ </picture>
128
+ </a>
129
+ </html>
130
+