sigal 2.5__tar.gz → 2.6__tar.gz

{sigal-2.5 → sigal-2.6}/.github/workflows/publish.yml

@@ -16,10 +16,10 @@ jobs:
     if: ((github.event_name == 'push' && startsWith(github.ref, 'refs/tags')) || contains(github.event.pull_request.labels.*.name, 'Build wheels'))
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
       with:
         fetch-depth: 0
-    - uses: actions/setup-python@v5
+    - uses: actions/setup-python@v6
       with:
         python-version: "3.13"
 

{sigal-2.5 → sigal-2.6}/.github/workflows/python-tests.yml

@@ -16,20 +16,22 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.9, "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
       with:
         fetch-depth: 0
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install FFmpeg
+        cache: 'pip'
+        cache-dependency-path: pyproject.toml
+    - name: Install FFmpeg & Poppler
       run: |
         sudo apt update
-        sudo apt install ffmpeg
+        sudo apt install ffmpeg poppler-utils
         ffmpeg -version
     - name: Install Tox
       run: python -m pip install tox tox-gh-actions coverage

{sigal-2.5 → sigal-2.6}/.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v5.0.0
+  rev: v6.0.0
   hooks:
     - id: check-added-large-files
     - id: check-merge-conflict
@@ -12,8 +12,8 @@ repos:
       exclude: ".*(galleria|photoswipe|jquery|leaflet).*$"
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.9.7
+  rev: v0.15.0
   hooks:
-    - id: ruff
+    - id: ruff-check
       args: [ --fix, --show-fixes, --exit-non-zero-on-fix ]
     - id: ruff-format

{sigal-2.5 → sigal-2.6}/.readthedocs.yml

@@ -1,9 +1,9 @@
 version: 2
 
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.12"
+    python: "3.13"
 
 sphinx:
   configuration: docs/conf.py

{sigal-2.5 → sigal-2.6}/LICENSE

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2009-2023 - Simon Conseil
+Copyright (c) 2009-2026 - Simon Conseil
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to

{sigal-2.5 → sigal-2.6}/PKG-INFO

@@ -1,28 +1,27 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: sigal
-Version: 2.5
+Version: 2.6
 Summary: Simple static gallery generator
 Author-email: Simon Conseil <contact@saimon.org>
-License: MIT License
+License-Expression: MIT
 Project-URL: repository, https://github.com/saimn/sigal
-Project-URL: documentation, http://sigal.saimon.org/en/latest/
+Project-URL: documentation, https://sigal.readthedocs.io/en/latest/
 Keywords: gallery,static,generator,image,video,galleria
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Multimedia :: Graphics :: Viewers
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
+Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: blinker
 Requires-Dist: click
 Requires-Dist: Jinja2>=2.7
 Requires-Dist: Markdown
-Requires-Dist: Pillow>=8.0.0
+Requires-Dist: Pillow>=10.0.0
 Requires-Dist: pilkit
 Requires-Dist: natsort
 Provides-Extra: all
@@ -31,6 +30,7 @@ Requires-Dist: feedgenerator; extra == "all"
 Requires-Dist: zopfli; extra == "all"
 Requires-Dist: cryptography; extra == "all"
 Requires-Dist: pillow-heif; extra == "all"
+Requires-Dist: pdf2image; extra == "all"
 Provides-Extra: tests
 Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-cov; extra == "tests"
@@ -38,6 +38,7 @@ Provides-Extra: docs
 Requires-Dist: Sphinx>=4.1.0; extra == "docs"
 Requires-Dist: furo; extra == "docs"
 Requires-Dist: cryptography; extra == "docs"
+Dynamic: license-file
 
 Sigal - Simple Static Gallery Generator
 =======================================
@@ -64,7 +65,7 @@ The idea behind Sigal is to ease the use of the javascript libraries like
 galleria_. These libraries do a great job to display the images, Sigal does
 what is missing: resize images, create thumbnails, generate HTML pages.
 
-Sigal requires Python 3.9+.
+Sigal requires Python 3.11+.
 
 Links
 -----
@@ -83,7 +84,7 @@ Javascript libraries:
 - `galleria demo`_
 - `photoswipe demo`_
 
-.. _website: http://sigal.saimon.org/
+.. _website: https://sigal.readthedocs.io/en/latest/
 .. _GitHub: https://github.com/saimn/sigal/
 .. _PyPI: https://pypi.org/project/sigal/
 .. _galleria: https://github.com/GalleriaJS/galleria

{sigal-2.5 → sigal-2.6}/README.rst

@@ -23,7 +23,7 @@ The idea behind Sigal is to ease the use of the javascript libraries like
 galleria_. These libraries do a great job to display the images, Sigal does
 what is missing: resize images, create thumbnails, generate HTML pages.
 
-Sigal requires Python 3.9+.
+Sigal requires Python 3.11+.
 
 Links
 -----
@@ -42,7 +42,7 @@ Javascript libraries:
 - `galleria demo`_
 - `photoswipe demo`_
 
-.. _website: http://sigal.saimon.org/
+.. _website: https://sigal.readthedocs.io/en/latest/
 .. _GitHub: https://github.com/saimn/sigal/
 .. _PyPI: https://pypi.org/project/sigal/
 .. _galleria: https://github.com/GalleriaJS/galleria

{sigal-2.5 → sigal-2.6}/docs/changelog.rst

@@ -2,6 +2,23 @@
  Changelog
 ===========
 
+Version 2.6
+~~~~~~~~~~~~~~
+
+Released on 2026-02-06.
+
+Sigal now requires Python 3.11+.
+
+- With the photoswipe theme, albums can contain both images and sub-albums
+  [:issue:`535`].
+- Fix issue with latest version of feedgenerator.
+- Fix compat with click 8.2.0.
+- Fix theme URL for photoswipe.
+- Thumbnail can now be set in ``index.md`` either with the original filename or
+  with the thumbnail name after format conversion [:issue:`476`].
+- Allow portrait orientation for thumbnails [:issue:`531`].
+- nonmedia_files plugin: adding support for PDF thumbnails [:issue:`536`].
+
 Version 2.5
 ~~~~~~~~~~~
 

{sigal-2.5 → sigal-2.6}/docs/conf.py

@@ -27,7 +27,7 @@ master_doc = "index"
 
 # General information about the project.
 project = "Sigal"
-copyright = "2012-2023, Simon Conseil"
+copyright = "2012-2026, Simon Conseil"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

{sigal-2.5 → sigal-2.6}/pyproject.toml

@@ -8,31 +8,31 @@ description = "Simple static gallery generator"
 readme = "README.rst"
 authors = [{name = "Simon Conseil", email = "contact@saimon.org"}]
 keywords = ["gallery", "static", "generator", "image", "video", "galleria"]
-license = {text = "MIT License"}
+license = "MIT"
+license-files = ["LICENSE"]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Environment :: Console",
-    "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
     "Topic :: Internet :: WWW/HTTP",
     "Topic :: Multimedia :: Graphics :: Viewers",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
-requires-python = ">=3.9"
+requires-python = ">=3.11"
 dependencies = [
     "blinker",
     "click",
     "Jinja2>=2.7",
     "Markdown",
-    "Pillow>=8.0.0",
+    "Pillow>=10.0.0",
     "pilkit",
     "natsort",
 ]
 dynamic = ["version"]
 
 [project.optional-dependencies]
-all = ["brotli", "feedgenerator", "zopfli", "cryptography", "pillow-heif"]
+all = ["brotli", "feedgenerator", "zopfli", "cryptography", "pillow-heif", "pdf2image"]
 tests = ["pytest", "pytest-cov"]
 docs = ["Sphinx>=4.1.0", "furo", "cryptography"]
 
@@ -41,11 +41,10 @@ sigal = "sigal.__main__:main"
 
 [project.urls]
 repository = "https://github.com/saimn/sigal"
-documentation = "http://sigal.saimon.org/en/latest/"
+documentation = "https://sigal.readthedocs.io/en/latest/"
 
 [tool.setuptools]
 include-package-data = true
-license-files = ["LICENSE"]
 
 [tool.setuptools.packages.find]
 where = ["src"]

{sigal-2.5 → sigal-2.6}/src/sigal/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2023 - Simon Conseil
+# Copyright (c) 2009-2026 - Simon Conseil
 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to

{sigal-2.5 → sigal-2.6}/src/sigal/__main__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2023 - Simon Conseil
+# Copyright (c) 2009-2026 - Simon Conseil
 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to
@@ -237,15 +237,17 @@ def serve(destination, port, config, browser):
         settings = read_settings(config)
         destination = settings.get("destination")
         if not os.path.exists(destination):
-            sys.stderr.write(
+            click.echo(
                 f"The '{destination}' directory doesn't exist, maybe try building"
-                " first?\n"
+                " first?",
+                err=True,
             )
             sys.exit(1)
     else:
-        sys.stderr.write(
+        click.echo(
             f"The {destination} directory doesn't exist "
-            f"and the config file ({config}) could not be read.\n"
+            f"and the config file ({config}) could not be read.",
+            err=True,
         )
         sys.exit(2)
 
@@ -284,10 +286,10 @@ def set_meta(target, keys, overwrite=False):
     """
 
     if not os.path.exists(target):
-        sys.stderr.write(f"The target {target} does not exist.\n")
+        click.echo(f"The target {target} does not exist.", err=True)
         sys.exit(1)
     if len(keys) < 2 or len(keys) % 2 > 0:
-        sys.stderr.write("Need an even number of arguments.\n")
+        click.echo("Need an even number of arguments.", err=True)
         sys.exit(1)
 
     if os.path.isdir(target):
@@ -295,9 +297,10 @@ def set_meta(target, keys, overwrite=False):
     else:
         descfile = os.path.splitext(target)[0] + ".md"
     if os.path.exists(descfile) and not overwrite:
-        sys.stderr.write(
+        click.echo(
             f"Description file '{descfile}' already exists. "
-            "Use --overwrite to overwrite it.\n"
+            "Use --overwrite to overwrite it.",
+            err=True,
         )
         sys.exit(2)
 

{sigal-2.5 → sigal-2.6}/src/sigal/gallery.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2023 - Simon Conseil
+# Copyright (c) 2009-2026 - Simon Conseil
 # Copyright (c) 2013      - Christophe-Marie Duquesne
 # Copyright (c) 2014      - Jonas Kaufmann
 # Copyright (c) 2015      - François D.
@@ -52,7 +52,7 @@ from .image import (
     get_size,
     process_image,
 )
-from .settings import Status, get_thumb
+from .settings import IMG_EXTENSIONS, Status, get_thumb
 from .utils import (
     Devnull,
     check_or_create_dir,
@@ -246,15 +246,10 @@ class Image(Media):
         super().__init__(filename, path, settings)
         imgformat = settings.get("img_format")
 
-        # Register all formats
-        PILImage.init()
-
-        if imgformat and PILImage.EXTENSION[self.src_ext] != imgformat.upper():
+        if imgformat and IMG_EXTENSIONS.ext2format[self.src_ext] != imgformat.upper():
             # Find the extension that should match img_format
-            extensions = {v: k for k, v in PILImage.EXTENSION.items()}
-            ext = extensions[imgformat.upper()]
+            ext = IMG_EXTENSIONS.format2ext[imgformat.upper()]
             self.dst_filename = self.basename + ext
-            self.thumb_name = get_thumb(self.settings, self.dst_filename)
 
     @cached_property
     def date(self):
@@ -593,76 +588,76 @@ class Album:
         # Test the thumbnail from the Markdown file.
         thumbnail = self.meta.get("thumbnail", [""])[0]
 
-        if thumbnail and isfile(join(self.src_path, thumbnail)):
-            self._thumbnail = url_from_path(
-                join(self.name, get_thumb(self.settings, thumbnail))
-            )
+        if thumbnail:
+            # if thumbnail is set in the markdown, it can be either the
+            # original filename or the generated name after format conversion
+            if isfile(join(self.src_path, thumbnail)):
+                thumbnail = get_thumb(self.settings, thumbnail)
+            self._thumbnail = url_from_path(join(self.name, thumbnail))
             self.logger.debug("Thumbnail for %r : %s", self, self._thumbnail)
             return self._thumbnail
-        else:
-            # find and return the first landscape image
-            for f in self.medias:
-                ext = splitext(f.dst_filename)[1]
-                if ext.lower() not in self.settings["img_extensions"]:
-                    continue
-
-                # Use f.size if available as it is quicker (in cache), but
-                # fallback to the size of src_path if dst_path is missing
-                size = f.input_size
-                if size is None:
-                    size = f.file_metadata["size"]
-
-                if size["width"] > size["height"]:
+
+        # find and return the first landscape image
+        for f in self.medias:
+            ext = splitext(f.dst_filename)[1]
+            if ext.lower() not in self.settings["img_extensions"]:
+                continue
+
+            # Use f.size if available as it is quicker (in cache), but
+            # fallback to the size of src_path if dst_path is missing
+            size = f.input_size
+            if size is None:
+                size = f.file_metadata["size"]
+
+            if size["width"] > size["height"]:
+                try:
+                    self._thumbnail = url_quote(self.name) + "/" + f.thumbnail
+                except Exception as e:
+                    self.logger.info(
+                        "Failed to get thumbnail for %s: %s", f.dst_filename, e
+                    )
+                else:
+                    self.logger.debug(
+                        "Use 1st landscape image as thumbnail for %r : %s",
+                        self,
+                        self._thumbnail,
+                    )
+                    return self._thumbnail
+
+        # else simply return the 1st media file
+        if not self._thumbnail and self.medias:
+            for media in self.medias:
+                if media.thumbnail is not None:
                     try:
-                        self._thumbnail = url_quote(self.name) + "/" + f.thumbnail
+                        self._thumbnail = url_quote(self.name) + "/" + media.thumbnail
                     except Exception as e:
                         self.logger.info(
-                            "Failed to get thumbnail for %s: %s", f.dst_filename, e
+                            "Failed to get thumbnail for %s: %s",
+                            media.dst_filename,
+                            e,
                         )
                     else:
-                        self.logger.debug(
-                            "Use 1st landscape image as thumbnail for %r : %s",
-                            self,
-                            self._thumbnail,
-                        )
-                        return self._thumbnail
-
-            # else simply return the 1st media file
-            if not self._thumbnail and self.medias:
-                for media in self.medias:
-                    if media.thumbnail is not None:
-                        try:
-                            self._thumbnail = (
-                                url_quote(self.name) + "/" + media.thumbnail
-                            )
-                        except Exception as e:
-                            self.logger.info(
-                                "Failed to get thumbnail for %s: %s",
-                                media.dst_filename,
-                                e,
-                            )
-                        else:
-                            break
-                else:
-                    self.logger.warning("No thumbnail found for %r", self)
-                    return
+                        break
+            else:
+                self.logger.warning("No thumbnail found for %r", self)
+                return
 
-                self.logger.debug(
-                    "Use the 1st image as thumbnail for %r : %s", self, self._thumbnail
-                )
-                return self._thumbnail
-
-            # use the thumbnail of their sub-directories
-            if not self._thumbnail:
-                for path, album in self.gallery.get_albums(self.path):
-                    if album.thumbnail:
-                        self._thumbnail = url_quote(self.name) + "/" + album.thumbnail
-                        self.logger.debug(
-                            "Using thumbnail from sub-directory for %r : %s",
-                            self,
-                            self._thumbnail,
-                        )
-                        return self._thumbnail
+            self.logger.debug(
+                "Use the 1st image as thumbnail for %r : %s", self, self._thumbnail
+            )
+            return self._thumbnail
+
+        # use the thumbnail of their sub-directories
+        if not self._thumbnail:
+            for path, album in self.gallery.get_albums(self.path):
+                if album.thumbnail:
+                    self._thumbnail = url_quote(self.name) + "/" + album.thumbnail
+                    self.logger.debug(
+                        "Using thumbnail from sub-directory for %r : %s",
+                        self,
+                        self._thumbnail,
+                    )
+                    return self._thumbnail
 
         self.logger.error("Thumbnail not found for %r", self)
 
@@ -918,14 +913,6 @@ class Gallery:
             ) as albums:
                 for album in albums:
                     if album.albums:
-                        if album.medias:
-                            self.logger.warning(
-                                "Album '%s' contains sub-albums and images. "
-                                "Please move images to their own sub-album. "
-                                "Images in album %s will not be visible.",
-                                album.title,
-                                album.title,
-                            )
                         album_list_writer.write(album)
                     else:
                         album_writer.write(album)

{sigal-2.5 → sigal-2.6}/src/sigal/image.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2023 - Simon Conseil
+# Copyright (c) 2009-2026 - Simon Conseil
 # Copyright (c) 2015 - François D.
 # Copyright (c) 2018 - Edwin Steele
 
@@ -99,6 +99,7 @@ def generate_image(source, outname, settings, options=None):
 
     img = _read_image(source)
     original_format = img.format
+    logger.debug("Read %s: %dx%d (%s)", source, *img.size, original_format)
 
     if settings["copy_exif_data"] and settings["autorotate_images"]:
         logger.warning(
@@ -149,7 +150,7 @@ def generate_image(source, outname, settings, options=None):
     # format, or fall back to JPEG
     outformat = settings.get("img_format") or img.format or original_format or "JPEG"
 
-    logger.debug("Save resized image to %s (%s)", outname, outformat)
+    logger.debug("Save resized image: %s, %dx%d (%s)", outname, *img.size, outformat)
     save_image(img, outname, outformat, options=options, autoconvert=True)
 
 
@@ -162,6 +163,7 @@ def generate_thumbnail(
     img = _read_image(source)
     img = Transpose().process(img)
     original_format = img.format
+    logger.debug("Read %s: %dx%d (%s)", source, *img.size, original_format)
 
     try:
         method = PILImage.Resampling.LANCZOS
@@ -175,7 +177,7 @@ def generate_thumbnail(
         img.thumbnail(box, method)
 
     outformat = img.format or original_format or "JPEG"
-    logger.debug("Save thumnail image: %s (%s)", outname, outformat)
+    logger.debug("Save thumbnail image: %s, %dx%d (%s)", outname, *img.size, outformat)
     save_image(img, outname, outformat, options=options, autoconvert=True)
 
 

{sigal-2.5 → sigal-2.6}/src/sigal/log.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2023 - Simon Conseil
+# Copyright (c) 2013-2026 - Simon Conseil
 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to

{sigal-2.5 → sigal-2.6}/src/sigal/plugins/feeds.py

@@ -70,6 +70,7 @@ def generate_feed(gallery, medias, feed_type=None, feed_url="", nb_items=0):
         feed.add_item(
             title=Markup.escape(item.title or item.url),
             link=link,
+            content=None,
             # unique_id='tag:%s,%s:%s' % (urlparse(link).netloc,
             #                             item.date.date(),
             #                             urlparse(link).path.lstrip('/')),

{sigal-2.5 → sigal-2.6}/src/sigal/plugins/media_page.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2023 - Simon Conseil
+# Copyright (c) 2009-2026 - Simon Conseil
 # Copyright (c)      2014 - Jamie Starke
 
 # Permission is hereby granted, free of charge, to any person obtaining a copy

{sigal-2.5 → sigal-2.6}/src/sigal/plugins/nonmedia_files.py

@@ -4,6 +4,9 @@ This plugin will copy the files into the build tree and generate generic
 thumbnails for the files.  In-browser previews will likely fail, and
 it is up to the theme to provide correct support for downloads.
 
+If the `pdf2image <https://pypi.org/project/pdf2image/>`_ optional dependency is installed,
+it will be used to generate thumbnails for PDF files.
+
 Settings available as dictionary in ``nonmedia_files_options``:
 
 - ``ext_as_thumb``: Enable simple thumbnail showing ext. Default to ``True``
@@ -26,6 +29,10 @@ Settings available as dictionary in ``nonmedia_files_options``:
 import logging
 import os
 
+try:  # Optional dependency:
+    from pdf2image import convert_from_path as pdf2img
+except ImportError:
+    pdf2img = None
 from PIL import Image as PILImage
 from PIL import ImageDraw, ImageFont
 from pilkit.utils import save_image
@@ -102,9 +109,7 @@ def generate_thumbnail(
     logger.info(f"kwargs: {kwargs}")
     d.text(anchor, text, anchor="mm", **kwargs)
 
-    outformat = "JPEG"
-    logger.info("Save thumnail image: %s (%s)", outname, outformat)
-    save_image(img, outname, outformat, options=options, autoconvert=True)
+    save_image(img, outname, "JPEG", options=options, autoconvert=True)
 
 
 def process_thumb(media):
@@ -113,18 +118,24 @@ def process_thumb(media):
     utils.copy(media.src_path, media.dst_path, symlink=settings["orig_link"])
 
     if plugin_settings.get("ext_as_thumb", DEFAULT_CONFIG["ext_as_thumb"]):
-        logger.info("plugin_settings: %r", plugin_settings)
-        kwargs = {}
-        for key in ("bg_color", "font", "font_color", "font_size"):
-            if f"thumb_{key}" in plugin_settings:
-                kwargs[key] = plugin_settings[f"thumb_{key}"]
-        generate_thumbnail(
-            media.src_ext[1:].upper(),
-            media.thumb_path,
-            settings["thumb_size"],
-            options=settings["jpg_options"],
-            **kwargs,
-        )
+        if pdf2img and media.src_ext.lower() == ".pdf":
+            images = pdf2img(
+                media.src_path, single_file=True, size=settings["thumb_size"]
+            )
+            images[0].save(media.thumb_path)
+        else:
+            kwargs = {}
+            for key in ("bg_color", "font", "font_color", "font_size"):
+                if f"thumb_{key}" in plugin_settings:
+                    kwargs[key] = plugin_settings[f"thumb_{key}"]
+            generate_thumbnail(
+                media.src_ext[1:].upper(),
+                media.thumb_path,
+                settings["thumb_size"],
+                options=settings["jpg_options"],
+                **kwargs,
+            )
+        logger.info("Saved thumbnail image: %s", media.thumb_path)
 
 
 def process_nonmedia(media):