Skip to main content

No project description provided

Project description

docker-image-size-limit

wemake.services Build status codecov Python Version wemake-python-styleguide

Limit your docker image size with a simple CLI command. Perfect to be used inside your CI process.

Read the announcing post.

Installation

pip install docker-image-size-limit

Or use our Github Action or pre-built docker image.

Usage

We support just a single command:

$ disl your-image-name:label 300MiB
your-image-name:label exceeds 300MiB limit by 114.4 MiB

Options

You can specify your image as:

  • Image name: python
  • Image name with tag: python:3.6.6-alpine

You can specify your size as:

  • Raw number of bytes: 1024
  • Human-readable megabytes: 30 MB or 30 MiB
  • Human-readable gigabytes: 1 GB or 1 GiB
  • Any other size supported by humanfriendly

Programmatic usage

You can also import and use this library as python code:

from docker import from_env
from docker_image_size_limit import check_image_size

oversize = check_image_size(from_env(), 'image-name:latest', '1 GiB')
assert oversize < 0, 'Too big image!'  # negative oversize - is a good thing!

We also ship PEP-561 compatible type annotations with this library.

Github Action

You can also use this check as a Gihub Action:

- uses: wemake-services/docker-image-size-limit@master
  with:
    image: "$YOUR_IMAGE_NAME"
    size: "$YOUR_SIZE_LIMIT"

Here's an example.

Docker Image

We have a pre-built image available.

First, pull our pre-built docker image:

docker pull wemakeservices/docker-image-size-limit

Then you can use it like so:

docker run -v /var/run/docker.sock:/var/run/docker.sock --rm \
  -e INPUT_IMAGE="$YOUR_IMAGE_NAME" \
  -e INPUT_SIZE="$YOUR_SIZE_LIMIT" \
  wemakeservices/docker-image-size-limit

Should I use it?

You can use this script instead:

LIMIT=1024  # adjust at your will
IMAGE='your-image-name:latest'

SIZE="$(docker image inspect "$IMAGE" --format='{{.Size}}')"
test "$SIZE" -gt "$LIMIT" && echo 'Limit exceeded'; exit 1 || echo 'Ok!'

But I prefer to reuse tools over custom bash scripts here and there.

License

MIT.

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

docker_image_size_limit-1.0.0.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

docker_image_size_limit-1.0.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file docker_image_size_limit-1.0.0.tar.gz.

File metadata

  • Download URL: docker_image_size_limit-1.0.0.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.0 Darwin/18.7.0

File hashes

Hashes for docker_image_size_limit-1.0.0.tar.gz
Algorithm Hash digest
SHA256 bf812f01e4d593139fd1cda6bc4b8135cb5d5cd7ea6ba709433c7c628dbd2804
MD5 00c9eceb05be76a03d0cc26833b8dbd1
BLAKE2b-256 43f6abdd3856c3a086645b4d480a41f3f03dcab7804db666cedee4aacd086b73

See more details on using hashes here.

File details

Details for the file docker_image_size_limit-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for docker_image_size_limit-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b1bfcaf910399f05e08287314fbbb737bcd43753490147091c702184f70bc163
MD5 440f40f7d848253da9945ce979092bf0
BLAKE2b-256 075e0a47fbffb963511fa58b3c9d5c7b30c8dce2b9ffd8afdb21300b7ea18ea0

See more details on using hashes here.

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