Merge pull request #119 from openzim/custom_icon

Add support for custom ZIM illustration

Author: benoit74

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Make the UI responsive (#22)
 - Enhance the UI design to be closer to original FCC UI (#23)
+- Add support for custom ZIM illustration (#79)
 
 ## [1.3.0] - 2025-01-24
 

scraper/src/fcc2zim/context.py

@@ -70,6 +70,9 @@ class Context:
     # Date when the crawl started
     start_date: datetime.date
 
+    # Path or URL to use as ZIM illustration
+    illustration: str | None = None
+
     # logger to use everywhere (do not mind about mutability, we want to reuse same
     # logger everywhere)
     logger: logging.Logger = getLogger(  # noqa: RUF009

scraper/src/fcc2zim/entrypoint.py

@@ -146,6 +146,11 @@ def prepare_context(raw_args: list[str]) -> None:
         dest="overwrite_existing_zim",
     )
 
+    parser.add_argument(
+        "--illustration",
+        help="Path or URL to ZIM illustration. Bitmap and SVG formats are supported.",
+    )
+
     args = parser.parse_args(raw_args)
 
     # Ignore unset values so they do not override the default specified in Context

scraper/src/fcc2zim/scraper.py

@@ -1,7 +1,11 @@
+import io
 import logging
 from pathlib import Path
 
-from zimscraperlib.inputs import compute_descriptions
+from zimscraperlib.image.conversion import convert_image, convert_svg2png
+from zimscraperlib.image.probing import format_for
+from zimscraperlib.image.transformation import resize_image
+from zimscraperlib.inputs import compute_descriptions, handle_user_provided_file
 from zimscraperlib.zim import Creator, metadata
 
 from fcc2zim.build import build_command
@@ -81,10 +85,36 @@ def __init__(self):
         else:
             logger.info(f"ZIM path: {self.zim_path}")
 
-        logo_path = Path(__file__).parent.joinpath("assets", "fcc_48.png")
+        if context.illustration:
+            logo_path = handle_user_provided_file(context.illustration)
+            if not logo_path:
+                raise ValueError(f"Logo not found at {context.illustration}")
+        else:
+            logo_path = Path(__file__).parent.joinpath("assets", "fcc_48.png")
         if not logo_path.exists():
             raise ValueError(f"Logo not found at {logo_path}")
 
+        illustration = io.BytesIO()
+        illustration_format = format_for(logo_path, from_suffix=False)
+        if illustration_format == "SVG":
+            convert_svg2png(
+                logo_path,
+                illustration,
+                metadata.DefaultIllustrationMetadata.illustration_size,
+                metadata.DefaultIllustrationMetadata.illustration_size,
+            )
+        else:
+            if illustration_format != "PNG":
+                convert_image(logo_path, illustration, fmt="PNG")
+            else:
+                illustration = io.BytesIO(logo_path.read_bytes())
+            resize_image(
+                illustration,
+                width=metadata.DefaultIllustrationMetadata.illustration_size,
+                height=metadata.DefaultIllustrationMetadata.illustration_size,
+                method="cover",
+            )
+
         self.creator = Creator(self.zim_path, "index.html").config_metadata(
             std_metadata=metadata.StandardMetadataList(
                 Name=metadata.NameMetadata(context.name),
@@ -94,7 +124,7 @@ def __init__(self):
                 Publisher=metadata.PublisherMetadata(context.publisher),
                 Date=metadata.DateMetadata(context.start_date),
                 Illustration_48x48_at_1=metadata.DefaultIllustrationMetadata(
-                    logo_path.read_bytes()
+                    illustration
                 ),
                 Description=metadata.DescriptionMetadata(context.description),
                 LongDescription=(