docker-image-cleanup 0.1.3__tar.gz → 0.2.0__tar.gz

{docker_image_cleanup-0.1.3 → docker_image_cleanup-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: docker-image-cleanup
-Version: 0.1.3
+Version: 0.2.0
 Summary: Clean up old Docker images from local storage with retention controls
 Keywords: docker,cleanup,images,disk-space
 Author: Michael Bianco
@@ -89,6 +89,18 @@ docker run -d \
   ghcr.io/iloveitaly/docker-image-cleanup:latest
 ```
 
+Here's an example script to get the latest image and restart any existing docker image:
+
+```
+docker pull ghcr.io/iloveitaly/docker-image-cleanup:latest
+docker stop docker-image-cleanup && docker rm docker-image-cleanup
+docker run -d \
+  --name docker-image-cleanup \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  -e TARGET_REPOS="repo.com/one repo.com/two" \
+  ghcr.io/iloveitaly/docker-image-cleanup:latest
+```
+
 ### Docker Compose
 
 ```yaml
@@ -132,4 +144,3 @@ Images with multiple tags are handled intelligently. If all tags on an image wou
 ---
 
 *This project was created from [iloveitaly/python-package-template](https://github.com/iloveitaly/python-package-template)*
-> theirs

{docker_image_cleanup-0.1.3 → docker_image_cleanup-0.2.0}/README.md

@@ -73,6 +73,18 @@ docker run -d \
   ghcr.io/iloveitaly/docker-image-cleanup:latest
 ```
 
+Here's an example script to get the latest image and restart any existing docker image:
+
+```
+docker pull ghcr.io/iloveitaly/docker-image-cleanup:latest
+docker stop docker-image-cleanup && docker rm docker-image-cleanup
+docker run -d \
+  --name docker-image-cleanup \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  -e TARGET_REPOS="repo.com/one repo.com/two" \
+  ghcr.io/iloveitaly/docker-image-cleanup:latest
+```
+
 ### Docker Compose
 
 ```yaml
@@ -116,4 +128,3 @@ Images with multiple tags are handled intelligently. If all tags on an image wou
 ---
 
 *This project was created from [iloveitaly/python-package-template](https://github.com/iloveitaly/python-package-template)*
-> theirs

{docker_image_cleanup-0.1.3 → docker_image_cleanup-0.2.0}/docker_image_cleanup/__init__.py

@@ -2,6 +2,7 @@
 Cleans up old Docker images from local storage with retention controls.
 """
 
+import sys
 from collections import defaultdict
 from typing import Any
 
@@ -113,7 +114,7 @@ def determine_cleanup_actions(
         if img.created >= min_age_threshold:
             keep_tags.update(img.tags)
 
-    images_to_delete_ids: set[str] = set()
+    images_to_delete: dict[str, int] = {}
     tags_to_remove: list[str] = []
 
     images_by_id: dict[str, list[ImageInfo]] = defaultdict(list)
@@ -142,7 +143,7 @@ def determine_cleanup_actions(
             if set(tags_for_this_image_to_remove) == current_image_repo_tags:
                 img_info = img_list[0]
                 if not img_info.is_in_use:
-                    images_to_delete_ids.add(img_id)
+                    images_to_delete[img_id] = img_info.size
                     total_size_saved += img_info.size
                 else:
                     log.warning(
@@ -152,7 +153,7 @@ def determine_cleanup_actions(
                     )
 
     return {
-        "images_to_delete": list(images_to_delete_ids),
+        "images_to_delete": images_to_delete,
         "tags_to_remove": list(set(tags_to_remove)),
         "total_size_saved": total_size_saved,
     }
@@ -160,7 +161,7 @@ def determine_cleanup_actions(
 
 def execute_cleanup(
     client: docker.DockerClient,
-    images_to_delete: list[str],
+    images_to_delete: dict[str, int],
     tags_to_remove: list[str],
     total_size_saved: int,
     dry_run: bool,
@@ -172,7 +173,7 @@ def execute_cleanup(
         if tags_to_remove:
             log.info("would remove tags", tags=tags_to_remove)
         if images_to_delete:
-            log.info("would remove images", image_ids=images_to_delete)
+            log.info("would remove images", image_ids=list(images_to_delete.keys()))
 
         log.info(
             "total space that would be saved",
@@ -184,19 +185,25 @@ def execute_cleanup(
     for tag in tags_to_remove:
         try:
             client.images.remove(tag, force=False)
-            log.info("untagged image", tag=tag)
+            log.info("removed tag", tag=tag)
         except docker.errors.APIError as e:
-            log.warning("skipped untagging", tag=tag, reason=str(e))
+            log.warning("skipped tag removal", tag=tag, reason=str(e))
 
-    for img_id in images_to_delete:
+    # We explicitly remove the Image ID here even after untagging.
+    # This is primarily to catch and clean up "dangling" images (images with no tags)
+    # that might have been orphaned but wouldn't be caught by the tag loop.
+    for img_id, size in images_to_delete.items():
         try:
-            img = client.images.get(img_id)
-            size = img.attrs.get("Size", 0)
             client.images.remove(img_id, force=False)
             log.info("removed image", image_id=img_id, size=format_size(size))
             executed_size_saved += size
         except docker.errors.ImageNotFound:
-            log.warning("image already removed", image_id=img_id)
+            # If the image is not found here, it means Docker automatically deleted
+            # the underlying image data when we removed its last tag in the loop above.
+            log.info(
+                "image removed via untagging", image_id=img_id, size=format_size(size)
+            )
+            executed_size_saved += size
         except docker.errors.APIError as e:
             log.warning("skipped image removal", image_id=img_id, reason=str(e))
 
@@ -264,6 +271,13 @@ def main(
             dry_run=dry_run,
         )
 
+        log.info(
+            "cleanup configuration",
+            num_recent=config.num_recent,
+            min_age_days=config.min_age_days,
+            dry_run=config.dry_run,
+        )
+
         grand_total_saved = 0
         for repo_name in image_repos:
             log.info("processing repository", repo=repo_name)
@@ -298,10 +312,10 @@ def main(
 
     except docker.errors.DockerException as e:
         log.error("failed to connect to Docker daemon", reason=str(e))
-        exit(1)
+        sys.exit(1)
     except Exception:
         log.exception("an unexpected error occurred")
-        exit(1)
+        sys.exit(1)
 
 
 if __name__ == "__main__":

docker_image_cleanup-0.2.0/pyproject.toml

@@ -0,0 +1,65 @@
+[project]
+name = "docker-image-cleanup"
+version = "0.2.0"
+description = "Clean up old Docker images from local storage with retention controls"
+keywords = [
+    "docker",
+    "cleanup",
+    "images",
+    "disk-space",
+]
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "click>=8.3.0",
+    "docker>=7.1.0",
+    "pydantic>=2.12.5",
+    "structlog-config>=0.6.0",
+    "whenever>=0.9.3",
+]
+
+[[project.authors]]
+name = "Michael Bianco"
+email = "mike@mikebian.co"
+
+[project.urls]
+Repository = "https://github.com/iloveitaly/docker-image-cleanup"
+
+[project.scripts]
+docker-image-cleanup = "docker_image_cleanup:main"
+
+[build-system]
+requires = ["uv_build>=0.11.0,<0.13"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-root = ""
+
+[tool.pyright]
+exclude = [
+    "examples/",
+    "playground/",
+    "tmp/",
+    ".venv/",
+    "tests/",
+]
+
+[tool.pytest.ini_options]
+addopts = "--cov --cov-report=term-missing --cov-report=html:tmp/htmlcov"
+
+[tool.coverage.run]
+plugins = ["covdefaults"]
+source = ["docker_image_cleanup"]
+
+[tool.coverage.report]
+fail_under = 50
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3.4",
+    "pyright[nodejs]>=1.1.408",
+    "ruff>=0.8.0",
+    "coverage>=7.13.4",
+    "pytest-cov>=7.0.0",
+    "covdefaults>=2.3.0",
+]

docker_image_cleanup-0.1.3/pyproject.toml → docker_image_cleanup-0.2.0/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "docker-image-cleanup"
-version = "0.1.3"
+version = "0.2.0"
 description = "Clean up old Docker images from local storage with retention controls"
 keywords = ["docker", "cleanup", "images", "disk-space"]
 readme = "README.md"
@@ -22,7 +22,7 @@ docker-image-cleanup = "docker_image_cleanup:main"
 
 
 [build-system]
-requires = ["uv_build>=0.11.0,<0.12"]
+requires = ["uv_build>=0.11.0,<0.13"]
 build-backend = "uv_build"
 
 [tool.uv.build-backend]