Skip to main content

Create different scaled versions of an image, in webp, jpg, png, svg,... to be used on resposive website

Project description

Pytest

Pypi version Pypi Download

Introduction

responsiveimage is a python package aimed at building responsive version of images.

Supported formats are:

  • image: webp, jpg, png, gif and svg
  • video: mp4, mts, avi, wmv, mov


Usage

Installation

Run python -m pip install responsiveimage to install the python package.

Also, please install the binaries ffmpeg and optipng (using apt-get, pacman, or directly from sourceforge) to further optimize the png version of the sprite.

Usage

  • resize and save all images in <srcdir> into <dstdir>. New size is 1920px by default (at largest dimension, keep the aspect-ratio), and save quality is:
    • gif and svg: direct copy
    • png: use Pillow library, with Optimize=True
    • jpg: quality=80, progressive, 4:2:2
    • webp: quality=80
    • mp4: use ffmpeg to scale at 1024
python -m responsiveimage --src-dir <srcdir> --dst-dir <dstdir>
  • --export-to-webp: also export the webp version of the image

  • --size <s1,s2...>: different scaling are generating, instead of the default 1920px. The max size will be s1, s2...

  • --height <s1,s2...>: different scaling are generating, based on the height which will be be s1, s2... Note that --size and --height cannot be used at the same time.

  • By default, the name of the created responsive versions of the image are

    • unchanged if there is a single scaled version of the image
    • or suffixed with -s1, -s2... otherwise.

    Option --add-name <name1,name2...>is used to modify the suffix, in name1 , name2. Note that the numbers of sizes or heights must be the same as the one of add-name if provided

    As an example, using --size 1024,512 --add-name _big,_small, an image img.jpg will be rescaled with 1024px and named img_big.jpg, and another one rescaled at 512px and named img_small.jpg

  • --mp4-as-gif: from a mp4 file, the gif and the webp animated versions are created, using ffmpeg

  • --crop <x1,y1,x2,y2> crops the original image using (x1,y1) as the top-left point (x being the horizontal position in px), and (x2,y2) being the bottom-right point.

  • --recursive to scan recursively the source directory. The directory tree is kept in destination

  • --format <f1,f2> to used to only process files of provided format. You can for example process only jpg and png to exclude videos. The default value is jpg,png,webp,gif,svg,mp4,mts,avi,wmv,mov

  • --force: recreate the scaled versions of the images, even when they exist.



Releases

1.2.0

  • Supported formats: webp, jpg, png, gif and svg, mp4, mts, avi, wmv, mov
  • New options:
    • --format
    • --recursive

1.1.1

  • Fix mp4: no upscale, along max size.
  • Fix HEIC format

1.1.0

Following capabilities are added:

  • --height
  • --add-name
  • --crop
  • --force

1.0.0

Initial version

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

responsiveimage-1.2.0.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

responsiveimage-1.2.0-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file responsiveimage-1.2.0.tar.gz.

File metadata

  • Download URL: responsiveimage-1.2.0.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for responsiveimage-1.2.0.tar.gz
Algorithm Hash digest
SHA256 8085efb3e20b058fc45809379c47b2b8e1dd9cc4f2d05330c4b6e47f9982f58f
MD5 7bff20116f2b29a808784e2ab0364e2f
BLAKE2b-256 605d9d8979917e7954739403abfdc3c1ba4767684ae42e06d7ee8e60a98d0da8

See more details on using hashes here.

File details

Details for the file responsiveimage-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for responsiveimage-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e6a1d6fb32bf6053c439b09d8d50e18bd73a7af087cb1912f818275fc9608bf
MD5 cbd3fe8b748ee1b4895b9fc008066a6b
BLAKE2b-256 71e92c9f2602d1ba845c5c7a3f953367cc03e301fdc10c94402c15dea0055127

See more details on using hashes here.

Supported by

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