🛠️ Welcome to Stouputils Documentation

Versions: latest, 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)
│   └── ...
│
├── 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
│   └── ...
│
├── print.py                 # 🖨️ Display utilities (info, debug, warning, error)
├── io.py                    # 💻 I/O utilities (file management, json)
├── decorators.py            # 🎯 Decorators (silent, measure_time, error_handler, simple_cache)
├── ctx.py                   # 🚫 Context managers (Muffle, LogToFile)
├── archive.py               # 📦 Archive utilities (zip, repair_zip)
├── parallel.py              # 🧑‍🤝‍🧑 Parallel processing (multiprocessing, multithreading)
├── collections.py           # 🧰 Collection utilities (unique_list)
├── all_doctests.py          # ✅ Execution of all doctests for a given path
├── backup.py                # 📦 Backup utilities (delta backup, consolidate)
└── ...

⭐ Star History

📖 Module Documentation

• stouputils package
  • Subpackages
    • stouputils.applications package
      • Submodules
        • stouputils.applications.automatic_docs module
          • get_sphinx_conf_content()
          • get_versions_from_github()
          • markdown_to_rst()
          • generate_index_rst()
          • generate_documentation()
          • generate_redirect_html()
          • update_documentation()
    • stouputils.continuous_delivery package
      • Submodules
        • stouputils.continuous_delivery.cd_utils module
          • load_credentials()
          • handle_response()
          • clean_version()
          • version_to_float()
        • stouputils.continuous_delivery.github module
          • validate_credentials()
          • validate_config()
          • handle_existing_tag()
          • delete_existing_release()
          • delete_existing_tag()
          • get_latest_tag()
          • get_commits_since_tag()
          • generate_changelog()
          • create_tag()
          • create_release()
          • upload_assets()
          • upload_to_github()
        • stouputils.continuous_delivery.pypi module
          • update_pip_and_required_packages()
          • build_package()
          • upload_package()
          • pypi_full_routine()
        • stouputils.continuous_delivery.pyproject module
          • read_pyproject()
          • format_toml_lists()
          • write_pyproject()
          • increment_version_from_input()
          • increment_version_from_pyproject()
          • get_version_from_pyproject()
    • stouputils.dont_look namespace
      • Submodules
        • stouputils.dont_look.zip_file_override module
          • ZipExtFileOverride
            • ZipExtFileOverride._update_crc()
            • ZipExtFileOverride._abc_impl
          • ZipFileOverride
            • ZipFileOverride.open()
  • Submodules
    • stouputils.all_doctests module
      • launch_tests()
    • stouputils.archive module
      • make_archive()
      • repair_zip_file()
    • stouputils.backup module
      • get_file_hash()
      • extract_hash_from_zipinfo()
      • get_all_previous_backups()
      • is_file_in_any_previous_backup()
      • create_delta_backup()
      • consolidate_backups()
      • backup_cli()
    • stouputils.collections module
      • unique_list()
    • stouputils.ctx module
      • Muffle
        • Muffle.mute_stderr
        • Muffle.original_stdout
        • Muffle.original_stderr
      • LogToFile
        • LogToFile.path
        • LogToFile.mode
        • LogToFile.encoding
        • LogToFile.file
        • LogToFile.common()
    • stouputils.decorators module
      • silent()
      • measure_time()
      • LogLevels
        • LogLevels.NONE
        • LogLevels.WARNING
        • LogLevels.WARNING_TRACEBACK
        • LogLevels.ERROR_TRACEBACK
        • LogLevels.RAISE_EXCEPTION
      • force_raise_exception
      • handle_error()
      • simple_cache()
      • deprecated()
    • stouputils.io module
      • replace_tilde()
      • clean_path()
      • get_root_path()
      • super_open()
      • super_copy()
      • super_json_load()
      • super_json_dump()
    • stouputils.parallel module
      • __handle_parameters()
      • multiprocessing()
      • multithreading()
    • stouputils.print module
      • remove_colors()
      • is_same_print()
      • info()
      • debug()
      • alt_debug()
      • suggestion()
      • progress()
      • warning()
      • error()
      • whatisit()
      • breakpoint()