Skip to main content

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

Metadata

Release files for zz-pix 0.0.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for zz-pix 0.0.9
File Size Uploaded
zz-pix-0.0.9.tar.gz 13.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for zz-pix 0.0.9
File Interpreter ABI Platform
zz_pix-0.0.9-py3-none-any.whl Python 3 none any Details

Total release size: 26.9 kB

Release files / zz-pix-0.0.9.tar.gz

Download URL zz-pix-0.0.9.tar.gz
Size 13.1 kB
Tags Source
SHA-256 checksum
How to use checksums
3d1b987a37c08446373667705057a36c4c99072fd2d0b0a38585648baf55fee1
BLAKE2b-256 checksum
How to use checksums
adf15bb2cc0cf5f34a59c2c4a1dd040cd7a98fc406a576b3febd9a3447923a8d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.10.11

Release files / zz_pix-0.0.9-py3-none-any.whl

Download URL zz_pix-0.0.9-py3-none-any.whl
Size 13.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
662fedad179bacf18031c9ed491609025a9051d96574e7934444635a1c16d7d9
BLAKE2b-256 checksum
How to use checksums
b2602711545cee02af58d241133265c56efc6785b32d8ec320311322e994c71b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.10.11

Release history Release notifications | RSS feed

This release

0.0.9 This release

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page