🛠️ Welcome to Stouputils Documentation#

Versions: latest, v1.3.4, v1.3.3, v1.3.2, v1.3.1, v1.3.0, v1.2.40, v1.2.39, v1.2.38, v1.2.37, v1.2.36, v1.2.35, v1.2.34, v1.2.31, v1.2.30, v1.2.29, v1.2.28, v1.2.27, v1.2.26, v1.2.25, v1.2.24, v1.2.23, v1.2.22, v1.2.21, v1.2.20, v1.2.19, v1.2.18, v1.2.17, v1.2.16, v1.2.13, v1.2.12, v1.2.11, v1.2.10, v1.2.9, v1.2.8, v1.2.7, v1.2.4, v1.2.2, v1.2.1, v1.2.0, v1.0.22, v1.0.21

🛠️ Project Badges#

📚 Project Overview#

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.

🚀 Project File Tree#

stouputils/
├── applications/
│   ├── automatic_docs.py    # 📚 Documentation generation utilities (used to create this documentation)
│   ├── upscaler/            # 🔎 Image & Video upscaler (configurable)
│   └── ...
│
├── continuous_delivery/
│   ├── cd_utils.py          # 🔧 Common utilities for continuous delivery
│   ├── github.py            # 📦 GitHub utilities (upload_to_github)
│   ├── pypi.py              # 📦 PyPI utilities (pypi_full_routine)
│   ├── pyproject.py         # 📝 Pyproject.toml utilities
│   └── ...
│
├── data_science/
│   ├── config/              # ⚙️ Configuration utilities for data science
│   ├── dataset/             # 📊 Dataset handling (dataset, dataset_loader, grouping_strategy)
│   ├── data_processing/     # 🔄 Data processing utilities (image augmentation, preprocessing)
│   │   ├── image/           # 🖼️ Image processing techniques
│   │   └── ...
│   ├── models/              # 🧠 ML/DL model interfaces and implementations
│   │   ├── keras/           # 🤖 Keras model implementations
│   │   ├── keras_utils/     # 🛠️ Keras utilities (callbacks, losses, visualizations)
│   │   └── ...
│   ├── scripts/             # 📜 Data science scripts (augment, preprocess, routine)
│   ├── metric_utils.py      # 📏 Metrics utilities for ML/DL models
│   ├── mlflow_utils.py      # 📊 MLflow integration utilities
│   └── ...
│
├── dont_look/               # 🙈 Internal utilities (zip_file_override)
│
├── installer/
│   ├── common.py            # 🔧 Common installer utilities
│   ├── downloader.py        # ⬇️ File download utilities
│   ├── linux.py             # 🐧 Linux-specific installer utilities
│   ├── main.py              # 🚀 Main installer functionality
│   ├── windows.py           # 💻 Windows-specific installer utilities
│   └── ...
│
├── all_doctests.py          # ✅ Execution of all doctests for a given path
├── archive.py               # 📦 Archive utilities (zip, repair_zip)
├── backup.py                # 📦 Backup utilities (delta backup, consolidate)
├── collections.py           # 🧰 Collection utilities (unique_list)
├── ctx.py                   # 🚫 Context managers (Muffle, LogToFile)
├── decorators.py            # 🎯 Decorators (silent, measure_time, error_handler, simple_cache)
├── image.py                 # 🖼️ Image utilities (image_resize)
├── io.py                    # 💻 I/O utilities (file management, json)
├── parallel.py              # 🧑‍🤝‍🧑 Parallel processing (multiprocessing, multithreading)
├── print.py                 # 🖨️ Display utilities (info, debug, warning, error)
└── ...

⭐ Star History#

📖 Module Documentation#

stouputils package
- Subpackages
- Submodules