README.md

Python Scripts Collection

Description

Collection of my own python scripts.

Sections

• cleanup
• compress
• copy_files
• delete
• generate_file_associations
• generate_folder_icons
• generate_folder_images
• generate_shortcuts
• group
• image
• jira
• miscellaneous
• overlay
• palette_tools
• pdf_to_image
• process_audio
• process_books
• process_games
• process_manga
• process_video
• rename
• replace
• steam
• symlinks

General Requirements

• Having python3 installed.
• Having the required dependencies installed.
  • You can run install_all_dependencies.py from the root level
  • You can run pip install -r requirements.txt individually from each module
• Having the required packages installed.
  • You can run install_all_packages.py from the root level
  • You can run pip install . individually from each package

Running

• Execute SCRIPT_NAME.py from the file explorer.
• Run py SCRIPT_NAME.py from the terminal.
  • Depending on your installation, the executable may be either of these: py py3 python python3.
  • Depending on the script, additional arguments may be used.
    Check the individual scripts for more info.

(replace SCRIPT_NAME with your script of choice)

Git Hooks

• Run git config core.hooksPath _hooks once per clone to enable the tracked hooks in _hooks.
• The pre-commit hook runs ruff check --fix and ruff format on staged files and re-stages the changes.
• The pre-push hook runs run_all_tests.py and blocks the push if any test fails.