minchinweb / minchin.pelican.plugins.optimize_images

A Pelican plugin that applies lossless compression on JPEG and PNG images.

Optimize Images

Optimize Images is a plugin for Pelican, a static site generator written in Python.

Optimize Images applies lossless compression on JPEG and PNG images, with no effect on image quality. It uses jpegtran and OptiPNG.

Installation

The easiest way to install Optimize Images is through the use of pip. This will also install the required Python dependencies automatically.

pip install minchin.pelican.plugins.optimize_images

It is assumed both jpegtran and OptiPNG are installed on system path.

If you are using Pelican 4.5, it should automatically be activated (through my AutoLoader plugin).

If you are using an earlier version of Pelican or autoloading isn't working, then in your pelicanconf.py file, add Optimize Images to your list of plugins:

PLUGINS = [
    # others...
    "minchin.pelican.plugins.optimize_images",
    # ...
]

Requirements

Optimize Images depends on (and is really only useful with) Pelican. This can be manually installed with pip:

pip install pelican

It is assumed both jpegtran and OptiPNG are installed on system path. On Windows, installers are available at each respective website. On Ubuntu systems, the two can be installed via apt-get:

apt-get install optipng libjpeg-progs

Configuration and Usage

The plugin will activate and optimize images upon finalized signal of pelican.

If add OPTIMIZE_IMAGES_DEV_MODE = True to your pelicanconf.py, this will disable the plugin, which is useful when developing your site locally.

Known Issues

Image manipulation like this can take some time to run. You may consider only adding this plugin to your publishconf.py (rather than your base pelicanconf.py) or add OPTIMIZE_IMAGES_DEV_MODE = True to your pelicanconf.py, which will then only run this image optimization in preparation for site publication.

An issue, as such, is that there is no formal test suite. Testing is currently limited to my in-use observations. I also run a basic check upon uploaded the package to PyPI that it can be downloaded and loaded into Python.

The package is tested in Python 3.10; compatibility with other version of Python is unknown, but there should be nothing particular keeping it from working with other "modern" versions of Python.

Credits

Original plugin from the Pelican-Plugins repo.

License

The plugin code is assumed to be under the AGPLv3 license (this is the license of the Pelican-Plugins repo).

minchin.pelican.plugins.optimize_images's Issues

Add "dev" (off) mode

Add a no-op dev mode to allow quicker interations for building your blog.

Add autoloader instructions

Add instructions to use the autoloader to the readme.

Add the autoloader the project requirements.