https://github.com/xinlin-z/smally
Compress JPG, PNG and GIF losslessly in batch mode
https://github.com/xinlin-z/smally
baseline-format gif gifsicle jpeg jpegtran jpg optipng png progressvie-format
Last synced: 5 months ago
JSON representation
Compress JPG, PNG and GIF losslessly in batch mode
- Host: GitHub
- URL: https://github.com/xinlin-z/smally
- Owner: xinlin-z
- License: other
- Created: 2019-08-11T09:11:24.000Z (almost 6 years ago)
- Default Branch: newstart
- Last Pushed: 2023-10-31T03:35:45.000Z (over 1 year ago)
- Last Synced: 2024-12-09T01:48:49.101Z (6 months ago)
- Topics: baseline-format, gif, gifsicle, jpeg, jpegtran, jpg, optipng, png, progressvie-format
- Language: Python
- Homepage:
- Size: 6.8 MB
- Stars: 24
- Watchers: 1
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Smally
* [How to Compress](#How-to-Compress)
* [JPEG](#JPEG)
* [PNG](#PNG)
* [GIF](#GIF)
* [How to Install](#How-to-Install)
* [How to Use](#How-to-Use)
* [APIs](#APIs)
* [Showcase](#Showcase)
Smally is a simple tool to compress JPEG, PNG and GIF files losslessly,
by invoking the famous `jpegtran`, `optipng` and `gifsicle` tools,
in batch mode, in-place and keep mtime unchanged. It is written
in Python, but heavily rely on shell.
## How to Compress
### JPEG
1. Using `jpegtran` to remove all metadata, create a baseline version
and a progressive version.
2. To compare among the original file, baseline and progressive
files, choose the smallest one in size.
3. Whenever possible, choose progressive version.
### PNG
Calling `optipng` to compress PNG, in the most crazy `-o7 -zm1-9` level.
### GIF
Calling `gifsicle` to compress GIF, by using `-O3 --color 256`.
## How to Install
```shell
# install tools on Fedora
$ sudo dnf install libjpeg-turbo-utils optipng gifsicle
# install tools on Ubuntu
$ sudo apt install libjpeg-turbo-progs optipng gifsicle
# install smally
$ pip install smally
```
## How to Use
```shell
# inline help
$ python -m smally -h
# to compress a single file, if option is not presented,
# smally will use file command to get file type info.
$ python -m smally [-j|-p|-g]
# to compress a directory
$ python -m smally -r -P
# to compress all png file in a directory
$ python -m smally -r -P -p
```
`-r`, recursively, it's a command line convention and normally you should
use it when deal with a directory.
`-P`, parallel process number, if it is missing, the logical cpu
count number will be used.
## APIs
4 APIs provided by smally:
```python
# import
from smally import (jpegtran,
optipng,
gifsicle,
is_jpeg_progressive)
# signature
def jpegtran(pathname: str) -> tuple[int,int]: ...
def optipng(pathname: str) -> tuple[int,int]: ...
def gifsicle(pathname: str) -> tuple[int,int]: ...
def is_jpeg_progressive(pathname: str) -> bool: ...
```
The first int in returned tuple is the byte number saved. It could be zero,
which means no save. The second int is the original file size.
## Showcase
```shell
$ python -m smally -r smally/tpic -P4
# parallel process number: 4
smally/tpic/102.jpg -24157 -16.38% [p]
smally/tpic/302.gif -333056 -19.67%
smally/tpic/testpic/302.gif -333056 -19.67%
smally/tpic/testpic/102.jpg -24157 -16.38% [p]
smally/tpic/201.png -548 -26.37%
smally/tpic/testpic/201.png -548 -26.37%
smally/tpic/testpic/testpic/102.jpg -24157 -16.38% [p]
smally/tpic/testpic/testpic/302.gif -333056 -19.67%
smally/tpic/testpic/testpic/201.png -548 -26.37%
```