docker-image-cleanup 0.1.2__tar.gz → 0.1.4__tar.gz

{docker_image_cleanup-0.1.2 → docker_image_cleanup-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: docker-image-cleanup
-Version: 0.1.2
+Version: 0.1.4
 Summary: Clean up old Docker images from local storage with retention controls
 Keywords: docker,cleanup,images,disk-space
 Author: Michael Bianco
@@ -14,6 +14,11 @@ Requires-Python: >=3.11
 Project-URL: Repository, https://github.com/iloveitaly/docker-image-cleanup
 Description-Content-Type: text/markdown
 
+[![Release Notes](https://img.shields.io/github/release/iloveitaly/docker-image-cleanup)](https://github.com/iloveitaly/docker-image-cleanup/releases)
+[![Downloads](https://static.pepy.tech/badge/docker-image-cleanup/month)](https://pepy.tech/project/docker-image-cleanup)
+![GitHub CI Status](https://github.com/iloveitaly/docker-image-cleanup/actions/workflows/build_and_publish.yml/badge.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 # Clean Up Images from Self-Hosted Docker Registries
 
 If you're running a self-hosted Docker registry (using tools like [unregistry](https://github.com/psviderski/unregistry)), you'll want to clean up old images to reclaim disk space. This tool connects to your local Docker daemon and removes old images from specified repositories while keeping the ones you actually need.
@@ -123,3 +128,7 @@ The cleanup process is straightforward:
 Images with multiple tags are handled intelligently. If all tags on an image would be removed, the entire image is deleted. If only some tags would be removed, those tags are untagged but the image remains.
 
 # [MIT License](LICENSE.md)
+
+---
+
+*This project was created from [iloveitaly/python-package-template](https://github.com/iloveitaly/python-package-template)*

{docker_image_cleanup-0.1.2 → docker_image_cleanup-0.1.4}/README.md

@@ -1,3 +1,8 @@
+[![Release Notes](https://img.shields.io/github/release/iloveitaly/docker-image-cleanup)](https://github.com/iloveitaly/docker-image-cleanup/releases)
+[![Downloads](https://static.pepy.tech/badge/docker-image-cleanup/month)](https://pepy.tech/project/docker-image-cleanup)
+![GitHub CI Status](https://github.com/iloveitaly/docker-image-cleanup/actions/workflows/build_and_publish.yml/badge.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 # Clean Up Images from Self-Hosted Docker Registries
 
 If you're running a self-hosted Docker registry (using tools like [unregistry](https://github.com/psviderski/unregistry)), you'll want to clean up old images to reclaim disk space. This tool connects to your local Docker daemon and removes old images from specified repositories while keeping the ones you actually need.
@@ -107,3 +112,7 @@ The cleanup process is straightforward:
 Images with multiple tags are handled intelligently. If all tags on an image would be removed, the entire image is deleted. If only some tags would be removed, those tags are untagged but the image remains.
 
 # [MIT License](LICENSE.md)
+
+---
+
+*This project was created from [iloveitaly/python-package-template](https://github.com/iloveitaly/python-package-template)*

{docker_image_cleanup-0.1.2 → docker_image_cleanup-0.1.4}/docker_image_cleanup/__init__.py

@@ -12,6 +12,8 @@ from pydantic import BaseModel, Field
 from structlog_config import configure_logger
 from whenever import Instant
 
+from .version import __version__ as __version__
+
 log = configure_logger()
 
 
@@ -48,9 +50,25 @@ def parse_docker_image(
     used_image_ids: set[
         str
     ],  # Use Any due to pyright resolution issues with docker library types
-) -> ImageInfo:
-    """Parses docker.models.images.Image into our ImageInfo model."""
-    created_instant = Instant.parse_iso(image_data.attrs["Created"])
+) -> ImageInfo | None:
+    """Parses docker.models.images.Image into our ImageInfo model.
+
+    Returns None if the creation date cannot be determined.
+    """
+    created_str = image_data.attrs.get("Created")
+    if not created_str:
+        metadata = image_data.attrs.get("Metadata") or {}
+        created_str = metadata.get("LastTagTime")
+
+    if not created_str or created_str == "0001-01-01T00:00:00Z":
+        log.warning(
+            "could not determine image age, skipping",
+            image_id=image_data.id,
+            tags=image_data.tags,
+        )
+        return None
+
+    created_instant = Instant.parse_iso(created_str)
     image_id = image_data.id
 
     return ImageInfo(
@@ -71,7 +89,11 @@ def get_images_to_process(
         log.info("no images found for repository", repo=repo_name)
         return []
 
-    parsed_images = [parse_docker_image(img, used_image_ids) for img in images]
+    parsed_images = [
+        parsed
+        for img in images
+        if (parsed := parse_docker_image(img, used_image_ids)) is not None
+    ]
     return sorted(parsed_images, key=lambda img: img.created, reverse=True)
 
 
@@ -91,7 +113,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)
@@ -120,7 +142,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(
@@ -130,7 +152,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,
     }
@@ -138,7 +160,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,
@@ -150,7 +172,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",
@@ -162,19 +184,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))
 

docker_image_cleanup-0.1.4/docker_image_cleanup/version.py

@@ -0,0 +1,34 @@
+"""Version handling for docker-image-cleanup."""
+
+import importlib.metadata
+from pathlib import Path
+
+
+def is_local_source_checkout() -> bool:
+    """Check if the code is running from a local source checkout."""
+    package_dir = Path(__file__).resolve().parent
+    # Since this is a flat layout (module-root = ""), repo root is the parent of the package dir
+    repo_root = package_dir.parent
+
+    return (repo_root / ".git").exists() and (repo_root / "pyproject.toml").exists()
+
+
+def get_version() -> str:
+    """Get the version string, appending .dev if running from source."""
+    try:
+        # Try to get the version of the installed package
+        version = importlib.metadata.version("docker-image-cleanup")
+    except importlib.metadata.PackageNotFoundError:
+        # Fallback for local development if not installed
+        version = "0.1.0"
+
+    if not is_local_source_checkout():
+        return version
+
+    if version.endswith(".dev"):
+        return version
+
+    return f"{version}.dev"
+
+
+__version__ = get_version()

{docker_image_cleanup-0.1.2 → docker_image_cleanup-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "docker-image-cleanup"
-version = "0.1.2"
+version = "0.1.4"
 description = "Clean up old Docker images from local storage with retention controls"
 keywords = ["docker", "cleanup", "images", "disk-space"]
 readme = "README.md"
@@ -15,12 +15,14 @@ dependencies = [
 authors = [{ name = "Michael Bianco", email = "mike@mikebian.co" }]
 urls = { "Repository" = "https://github.com/iloveitaly/docker-image-cleanup" }
 
+
 # additional packaging information: https://packaging.python.org/en/latest/specifications/core-metadata/#license
 [project.scripts]
 docker-image-cleanup = "docker_image_cleanup:main"
 
+
 [build-system]
-requires = ["uv_build>=0.9.0,<0.10.0"]
+requires = ["uv_build>=0.11.0,<0.12"]
 build-backend = "uv_build"
 
 [tool.uv.build-backend]
@@ -28,10 +30,24 @@ build-backend = "uv_build"
 module-root = ""
 
 [dependency-groups]
-dev = ["pytest>=8.3.3", "pyright[nodejs]>=1.1.380", "ruff>=0.8.0"]
+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",
+]
 
 [tool.pyright]
 exclude = ["examples/", "playground/", "tmp/", ".venv/", "tests/"]
 
-[tool.ruff]
-extend-exclude = ["playground.py", "playground/"]
+[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