# docker-image-size-limit
[](https://wemake.services)
[](https://github.com/wemake-services/docker-image-size-limit/actions?query=workflow%3Atest)
[](https://codecov.io/gh/wemake-services/docker-image-size-limit)
[](https://pypi.org/project/docker-image-size-limit/)
[](https://github.com/wemake-services/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](https://sobolevn.me/2019/03/announcing-docker-image-size-limit).
## Installation
```bash
pip install docker-image-size-limit
```
Or use our [Github Action](https://github.com/wemake-services/docker-image-size-limit#github-action) or [pre-built docker image](https://github.com/wemake-services/docker-image-size-limit#docker-image).
## Usage
We support just a single command:
```bash
$ disl your-image-name:label 300MiB
your-image-name:label exceeds 300MiB limit by 114.4 MiB
```
Add `--max-layers` flag to also lint the maximum amount of layers possible
in your image:
```bash
# If your image has 7 layers:
$ disl your-image-name:label 300MiB --max-layers=5
your-image-name:label exceeds 5 maximum layers by 2
# If your image has 5 layers:
$ disl your-image-name:label 300MiB --max-layers=5
# ok!
```
Add `--current-size` flag to show the current size your image:
```bash
$ disl your-image-name:label 300MiB --current-size
your-image-name:label size is 414.4 MiB
your-image-name:label exceeds 300MiB limit by 114.4 MiB
```
Add `--exit-zero` flag to force the exit code to be 0 even if there are errors:
```bash
$ disl your-image-name:label 300MiB --exit-zero
your-image-name:label exceeds 300MiB limit by 114.4 MiB
$ echo $?
0
```
You can combine all flags together:
```bash
$ disl your-image-name:label 300MiB --max-layers=5 --current-size --exit-zero
your-image-name:label size is 414.4 MiB
your-image-name:label exceeds 300MiB limit by 114.4 MiB
your-image-name:label exceeds 5 maximum layers by 2
```
Run `disl` as a module:
```bash
$ python -m docker_image_size_limit 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`](https://humanfriendly.readthedocs.io/en/latest/api.html#humanfriendly.parse_size)
## Programmatic usage
You can also import and use this library as `python` code:
```python
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](https://www.python.org/dev/peps/pep-0561/)
compatible type annotations with this library.
## GitHub Action
You can also use this check as a [GitHub Action](https://github.com/marketplace/actions/docker-image-size-limit):
```yaml
- uses: wemake-services/docker-image-size-limit@master
with:
image: "$YOUR_IMAGE_NAME"
size: "$YOUR_SIZE_LIMIT"
# optional fields:
max_layers: 5
show_current_size: false
exit_zero: false
```
Here's [an example](https://github.com/wemake-services/docker-image-size-limit/actions?query=workflow%3Adisl).
## Docker Image
We have a [pre-built image](https://hub.docker.com/r/wemakeservices/docker-image-size-limit) available.
First, pull our pre-built docker image:
```bash
docker pull wemakeservices/docker-image-size-limit
```
Then you can use it like so:
```bash
docker run -v /var/run/docker.sock:/var/run/docker.sock --rm \
-e INPUT_IMAGE="$YOUR_IMAGE_NAME" \
-e INPUT_SIZE="$YOUR_SIZE_LIMIT" \
-e INPUT_MAX_LAYERS="$YOUR_MAX_LAYERS" \
-e INPUT_SHOW_CURRENT_SIZE="true" \
-e INPUT_EXIT_ZERO="true" \
wemakeservices/docker-image-size-limit
```
## Should I use it?
You can use this script instead:
```bash
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/wemake-services/docker-image-size-limit",
"name": "docker-image-size-limit",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "docker, docker image, size limit, wemake.services, code quality",
"author": "Nikita Sobolev",
"author_email": "mail@sobolevn.me",
"download_url": "https://files.pythonhosted.org/packages/6d/5b/d10133ecdfb1c1135d52853fc58a521965d76c8e65b064a982babd6b1664/docker_image_size_limit-2.1.0.tar.gz",
"platform": null,
"description": "# docker-image-size-limit\n\n[](https://wemake.services)\n[](https://github.com/wemake-services/docker-image-size-limit/actions?query=workflow%3Atest)\n[](https://codecov.io/gh/wemake-services/docker-image-size-limit)\n[](https://pypi.org/project/docker-image-size-limit/)\n[](https://github.com/wemake-services/wemake-python-styleguide)\n\nLimit your `docker` image size with a simple CLI command.\nPerfect to be used inside your CI process.\n\nRead the [announcing post](https://sobolevn.me/2019/03/announcing-docker-image-size-limit).\n\n\n## Installation\n\n```bash\npip install docker-image-size-limit\n```\n\nOr use our [Github Action](https://github.com/wemake-services/docker-image-size-limit#github-action) or [pre-built docker image](https://github.com/wemake-services/docker-image-size-limit#docker-image).\n\n\n## Usage\n\nWe support just a single command:\n\n```bash\n$ disl your-image-name:label 300MiB\nyour-image-name:label exceeds 300MiB limit by 114.4 MiB\n```\n\nAdd `--max-layers` flag to also lint the maximum amount of layers possible\nin your image:\n\n```bash\n# If your image has 7 layers:\n$ disl your-image-name:label 300MiB --max-layers=5\nyour-image-name:label exceeds 5 maximum layers by 2\n\n# If your image has 5 layers:\n$ disl your-image-name:label 300MiB --max-layers=5\n# ok!\n```\n\nAdd `--current-size` flag to show the current size your image:\n\n```bash\n$ disl your-image-name:label 300MiB --current-size\nyour-image-name:label size is 414.4 MiB\nyour-image-name:label exceeds 300MiB limit by 114.4 MiB\n```\n\n\nAdd `--exit-zero` flag to force the exit code to be 0 even if there are errors:\n\n```bash\n$ disl your-image-name:label 300MiB --exit-zero\nyour-image-name:label exceeds 300MiB limit by 114.4 MiB\n\n$ echo $?\n0\n```\n\nYou can combine all flags together:\n\n```bash\n$ disl your-image-name:label 300MiB --max-layers=5 --current-size --exit-zero\nyour-image-name:label size is 414.4 MiB\nyour-image-name:label exceeds 300MiB limit by 114.4 MiB\nyour-image-name:label exceeds 5 maximum layers by 2\n```\n\nRun `disl` as a module:\n\n```bash\n$ python -m docker_image_size_limit your-image-name:label 300MiB\nyour-image-name:label exceeds 300MiB limit by 114.4 MiB\n```\n\n\n\n## Options\n\nYou can specify your image as:\n\n- Image name: `python`\n- Image name with tag: `python:3.6.6-alpine`\n\nYou can specify your size as:\n\n- Raw number of bytes: `1024`\n- Human-readable megabytes: `30 MB` or `30 MiB`\n- Human-readable gigabytes: `1 GB` or `1 GiB`\n- Any other size supported by [`humanfriendly`](https://humanfriendly.readthedocs.io/en/latest/api.html#humanfriendly.parse_size)\n\n\n## Programmatic usage\n\nYou can also import and use this library as `python` code:\n\n```python\nfrom docker import from_env\nfrom docker_image_size_limit import check_image_size\n\noversize = check_image_size(from_env(), 'image-name:latest', '1 GiB')\nassert oversize < 0, 'Too big image!' # negative oversize - is a good thing!\n```\n\nWe also ship [PEP-561](https://www.python.org/dev/peps/pep-0561/)\ncompatible type annotations with this library.\n\n\n## GitHub Action\n\nYou can also use this check as a [GitHub Action](https://github.com/marketplace/actions/docker-image-size-limit):\n\n```yaml\n- uses: wemake-services/docker-image-size-limit@master\n with:\n image: \"$YOUR_IMAGE_NAME\"\n size: \"$YOUR_SIZE_LIMIT\"\n # optional fields:\n max_layers: 5\n show_current_size: false\n exit_zero: false\n```\n\nHere's [an example](https://github.com/wemake-services/docker-image-size-limit/actions?query=workflow%3Adisl).\n\n\n## Docker Image\n\nWe have a [pre-built image](https://hub.docker.com/r/wemakeservices/docker-image-size-limit) available.\n\nFirst, pull our pre-built docker image:\n\n```bash\ndocker pull wemakeservices/docker-image-size-limit\n```\n\nThen you can use it like so:\n\n```bash\ndocker run -v /var/run/docker.sock:/var/run/docker.sock --rm \\\n -e INPUT_IMAGE=\"$YOUR_IMAGE_NAME\" \\\n -e INPUT_SIZE=\"$YOUR_SIZE_LIMIT\" \\\n -e INPUT_MAX_LAYERS=\"$YOUR_MAX_LAYERS\" \\\n -e INPUT_SHOW_CURRENT_SIZE=\"true\" \\\n -e INPUT_EXIT_ZERO=\"true\" \\\n wemakeservices/docker-image-size-limit\n```\n\n\n## Should I use it?\n\nYou can use this script instead:\n\n```bash\nLIMIT=1024 # adjust at your will\nIMAGE='your-image-name:latest'\n\nSIZE=\"$(docker image inspect \"$IMAGE\" --format='{{.Size}}')\"\ntest \"$SIZE\" -gt \"$LIMIT\" && echo 'Limit exceeded'; exit 1 || echo 'Ok!'\n```\n\nBut I prefer to reuse tools over\ncustom `bash` scripts here and there.\n\n\n## License\n\nMIT.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": null,
"version": "2.1.0",
"project_urls": {
"Funding": "https://github.com/sponsors/wemake-services",
"Homepage": "https://github.com/wemake-services/docker-image-size-limit",
"Repository": "https://github.com/wemake-services/docker-image-size-limit"
},
"split_keywords": [
"docker",
" docker image",
" size limit",
" wemake.services",
" code quality"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b3155a29ede18bb82423b4bb1b90ad955b7d58cf46b729c29895218c75e93ee9",
"md5": "9e339cdb903173b75d505f5e46c85a7d",
"sha256": "02c6bfbd52032793e2f6951d30ba84c2a761fc6c42ca082198d6531c96737af0"
},
"downloads": -1,
"filename": "docker_image_size_limit-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e339cdb903173b75d505f5e46c85a7d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 6668,
"upload_time": "2025-01-13T13:52:05",
"upload_time_iso_8601": "2025-01-13T13:52:05.050397Z",
"url": "https://files.pythonhosted.org/packages/b3/15/5a29ede18bb82423b4bb1b90ad955b7d58cf46b729c29895218c75e93ee9/docker_image_size_limit-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d5bd10133ecdfb1c1135d52853fc58a521965d76c8e65b064a982babd6b1664",
"md5": "db3df9f2614fe195035ac65c6422637e",
"sha256": "21687281d6053919aa79fd9bdbbefa41be9473a4e3b9d4000c5c11bba8bff08c"
},
"downloads": -1,
"filename": "docker_image_size_limit-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "db3df9f2614fe195035ac65c6422637e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 5218,
"upload_time": "2025-01-13T13:52:07",
"upload_time_iso_8601": "2025-01-13T13:52:07.507330Z",
"url": "https://files.pythonhosted.org/packages/6d/5b/d10133ecdfb1c1135d52853fc58a521965d76c8e65b064a982babd6b1664/docker_image_size_limit-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-13 13:52:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wemake-services",
"github_project": "docker-image-size-limit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "docker-image-size-limit"
}
JSON
