# 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!
```
## 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"
```
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" \
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/57/08/1a8338dc0f05649b553de9474797066fc34f1a87a105eb9b213a2fc1e1df/docker_image_size_limit-2.0.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\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```\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 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.0.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": "d45872d88aa79ceb6cbc20e8e99ff72b25d0d341978295ed68d17f2aafedb97d",
"md5": "d8fbc52eb8d8c8456345735afb891031",
"sha256": "52f16a1e628f97842fe0c6bf9f0c5a64a7a18e718c9a3adf41e659233667ec37"
},
"downloads": -1,
"filename": "docker_image_size_limit-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d8fbc52eb8d8c8456345735afb891031",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 5860,
"upload_time": "2024-09-28T11:33:00",
"upload_time_iso_8601": "2024-09-28T11:33:00.025204Z",
"url": "https://files.pythonhosted.org/packages/d4/58/72d88aa79ceb6cbc20e8e99ff72b25d0d341978295ed68d17f2aafedb97d/docker_image_size_limit-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "57081a8338dc0f05649b553de9474797066fc34f1a87a105eb9b213a2fc1e1df",
"md5": "cbb9f91ffa98338a9862ffaae1a3d2b6",
"sha256": "591703b475964fd12d9b7c04fb5b6d71a6306e45f3bc10fef8e92d62520a12f1"
},
"downloads": -1,
"filename": "docker_image_size_limit-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "cbb9f91ffa98338a9862ffaae1a3d2b6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 4838,
"upload_time": "2024-09-28T11:33:01",
"upload_time_iso_8601": "2024-09-28T11:33:01.509670Z",
"url": "https://files.pythonhosted.org/packages/57/08/1a8338dc0f05649b553de9474797066fc34f1a87a105eb9b213a2fc1e1df/docker_image_size_limit-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-28 11:33:01",
"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
