# 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
```
## 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 [Gihub 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": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"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/6e/66/0fe1df4a8efdc48635bc70755051348b608cd90736d4fe1e02e843815d07/docker_image_size_limit-1.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\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 [Gihub 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": "",
"version": "1.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": "ec7303d44d5af92a45b89cdc7dab2ddabab14df1214acf874b3b1f01d53186f6",
"md5": "4861f1055d9d6157e0550b64fb056194",
"sha256": "101425bc782422ec4d74578f7cc453563a5b7ed83e3f248f99c92b39fee09132"
},
"downloads": -1,
"filename": "docker_image_size_limit-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4861f1055d9d6157e0550b64fb056194",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 5489,
"upload_time": "2024-02-22T08:31:34",
"upload_time_iso_8601": "2024-02-22T08:31:34.072301Z",
"url": "https://files.pythonhosted.org/packages/ec/73/03d44d5af92a45b89cdc7dab2ddabab14df1214acf874b3b1f01d53186f6/docker_image_size_limit-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6e660fe1df4a8efdc48635bc70755051348b608cd90736d4fe1e02e843815d07",
"md5": "2e9de641c53c04829ff9534dad929f69",
"sha256": "e6a5a37d4fa4487f09e8ec87f9626521c500dac73b1d4d43111ec9bac88ce065"
},
"downloads": -1,
"filename": "docker_image_size_limit-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "2e9de641c53c04829ff9534dad929f69",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 4422,
"upload_time": "2024-02-22T08:31:35",
"upload_time_iso_8601": "2024-02-22T08:31:35.952899Z",
"url": "https://files.pythonhosted.org/packages/6e/66/0fe1df4a8efdc48635bc70755051348b608cd90736d4fe1e02e843815d07/docker_image_size_limit-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-22 08:31:35",
"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
