Skip to main content

CLI tool for image manipulation

Project description

PIX

PyPI - Version PyPI - License Downloads

PyPI - Python Version

A simple image manipulation tool for the terminal.

⭐️ Like this repo? please consider a star!

💡 This project is still earily in its development. Please report any bugs or issues you encounter.

🌟 Features

  • Resize
  • Crop
  • Convert
  • Prune (remove low-quality images)
  • Caption (add text & metadata to images)
  • Transparency
  • Watermark
  • Grayscale

💻 Installation

Using pip (Recommended)

pip install zz-pix

From Source

git clone https://github.com/sean1832/pix.git
cd pix
pip install .

🔨 Usage

Basic Usage

pix [COMMAND] [OPTIONS]

Replace [COMMAND] with the desired operation and [OPTIONS] with the relevant options for your command.

Global Options

  • -v, --version: Display the version of the tool.
  • -h, --help: Display the help message.

Commands

Command Description
convert Converts images to a different format
resize Resizes images
crop Crops images
prune Removes images smaller than specified resolution

Command Options

Convert

Converts images to a different formats. Currently supports JPEG, PNG, WEBP, TIFF, ICO, AVIF, HEIF, BMP.

pix convert input.jpg output.webp [OPTIONS]
Option Input Type Description Default
input String Input image or directory N/A
output String Output image or directory Current dir.
-f, --format String Output format (supported formats listed) N/A
-q, --quality Integer Output quality (0-100) 95
--no-optimize Flag Disable optimization N/A
-o, --overwrite Flag Overwrite existing files N/A
-t, --transparent Flag Preserve transparency N/A
--prefix String Prefix for the output file name ""
--surfix String Suffix for the output file name ""

Resize

Resizes images to a specified size or scale.

pix resize input.jpg output.jpg [OPTIONS]
Option Input Type Description Default
input String Input image or directory N/A
output String Output image or directory Current dir.
--overwrite Flag Overwrite existing files N/A
--size String Output size (WxH) N/A
--scale Float Output scale (0.0-1.0) N/A

Crop

Crops images to a specified size and position.

pix crop input.jpg output.jpg [OPTIONS]
Option Input Type Description Default
input String Input image or directory N/A
output String Output image or directory Current dir.
--overwrite Flag Overwrite existing files N/A
--ratio String Aspect ratio (W:H), combined with --align N/A
--size String Exact size and position as WxH+X+Y N/A
--align String Alignment (top, bottom, left, right, center) N/A

Prune

Removes images smaller than a specified resolution.

pix prune ./images [OPTIONS]
Option Input Type Description Default
input String Input image or directory N/A
-r, --resolution String Minimum resolution (WxH) N/A
--dry-run Flag List files to be removed without deleting them N/A

License

Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zz-pix-0.0.9.tar.gz (13.1 kB view hashes)

Uploaded Source

Built Distribution

zz_pix-0.0.9-py3-none-any.whl (13.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page