Skip to content

Latest commit

 

History

History
78 lines (69 loc) · 2.4 KB

README.md

File metadata and controls

78 lines (69 loc) · 2.4 KB
Raw

LocalUtilityBox

Don't waste your time searching for web solutions, do it in your terminal.

LocalUtilityBox is a versatile command-line utility designed to simplify your image and document processing tasks. With LocalUtilityBox, you can:

  • Work locally, keeping your data private and secure.
  • Avoid online tools that share your files on external servers.
  • Enjoy efficient processing directly from your terminal.

Features

LocalUtilityBox comes packed with tools to make your life easier:

  • Image Processing
    • Convert images between formats (e.g., WebP, JPG, PNG).
    • Resize and compress images.
    • Batch-process entire folders.
  • PDF Management
    • Split, merge, and extract text or images from PDFs.
    • Convert PDFs to image files for easy use.
  • Convenient CLI Tools
    • User-friendly command-line commands for all operations.

Installation

Get started with LocalUtilityBox in just a few steps:

  1. Clone the Repository
git clone https://github.com/elokwentnie/LocalUtilityBox.git
  1. Navigate to the Project Directory
cd LocalUtilityBox
  1. Set Up a Local Python Environment
python3 -m venv env
source env/bin/activate
  1. Install Dependencies and Package Ensure you have pip installed. Then, run:
pip3 install .

This command will install LocalUtilityBox and its dependencies as specified in requirements.txt.

Set Up the PYTHONPATH

export PYTHONPATH=$PYTHONPATH:/path/to/LocalUtilityBox/src

Usage

Once installed, LocalUtilityBox provides a set of simple commands for various tasks. Here are a few examples to get you started:

  • Image Conversion
    • Convert WebP to JPG: 
      webp_to_jpg [-h] [-o OUTPUT_FILE] [-b {white,black}] input_file
    • Remove background from image 
      remove_background [-h] (-f INPUT_FILES [INPUT_FILES ...] | -d INPUT_DIRECTORY)
  • PDF Management
    • Merge PDFs: 
      merge_pdf [-h] (-f INPUT_FILES [INPUT_FILES ...] | -d INPUT_DIRECTORY) [-o OUTPUT]
    • Convert DOC to PDF: 
      doc_to_pdf [-h] [-o OUTPUT_FILE] input_file
    • Extract text from images:
    extract_text_from_img [-h] [-s] input_file

Contribute

Have ideas or improvements? Contributions are welcome! Feel free to fork the repository, make your changes, and submit a pull request.

Let me know if there’s anything more you’d like to include or refine!