sigal 2.4__py3-none-any.whl → 2.5__py3-none-any.whl

sigal/__main__.py

@@ -25,6 +25,7 @@ import pathlib
 import socketserver
 import sys
 import time
+import webbrowser
 from http import server
 
 import click
@@ -227,7 +228,8 @@ def build(
     show_default=True,
     help="Configuration file",
 )
-def serve(destination, port, config):
+@option("-b", "--browser", is_flag=True, help="Open in your default browser")
+def serve(destination, port, config, browser):
     """Run a simple web server."""
     if os.path.exists(destination):
         pass
@@ -253,6 +255,9 @@ def serve(destination, port, config):
     httpd = socketserver.TCPServer(("", port), Handler, False)
     print(f" * Running on http://127.0.0.1:{port}/")
 
+    if browser:
+        webbrowser.open(f"http://127.0.0.1:{port}/")
+
     try:
         httpd.allow_reuse_address = True
         httpd.server_bind()

sigal/gallery.py

@@ -45,7 +45,13 @@ from natsort import natsort_keygen, ns
 from PIL import Image as PILImage
 
 from . import image, signals, video
-from .image import get_exif_tags, get_image_metadata, get_size, process_image
+from .image import (
+    EXIF_EXTENSIONS,
+    get_exif_tags,
+    get_image_metadata,
+    get_size,
+    process_image,
+)
 from .settings import Status, get_thumb
 from .utils import (
     Devnull,
@@ -264,7 +270,7 @@ class Image(Media):
         datetime_format = self.settings["datetime_format"]
         return (
             get_exif_tags(self.raw_exif, datetime_format=datetime_format)
-            if self.raw_exif and self.src_ext in (".jpg", ".jpeg")
+            if self.raw_exif and self.src_ext in EXIF_EXTENSIONS
             else None
         )
 
@@ -289,7 +295,7 @@ class Image(Media):
     @cached_property
     def raw_exif(self):
         """If not `None`, contains the raw EXIF tags."""
-        if self.src_ext in (".jpg", ".jpeg"):
+        if self.src_ext in EXIF_EXTENSIONS:
             return self.file_metadata["exif"]
 
     @cached_property
@@ -486,6 +492,7 @@ class Album:
             reverse = self.settings["albums_sort_reverse"]
 
             if "sort" in self.meta:
+                # override default sort order from settings
                 albums_sort_attr = self.meta["sort"][0]
                 if albums_sort_attr[0] == "-":
                     albums_sort_attr = albums_sort_attr[1:]
@@ -515,7 +522,7 @@ class Album:
                         continue
                 return ""
 
-            key = natsort_keygen(key=sort_key, alg=ns.LOCALE)
+            key = natsort_keygen(key=sort_key, alg=ns.SIGNED | ns.LOCALE)
             self.subdirs.sort(key=key, reverse=reverse)
 
         signals.albums_sorted.send(self)
@@ -530,11 +537,13 @@ class Album:
             elif medias_sort_attr.startswith("meta."):
                 meta_key = medias_sort_attr.split(".", 1)[1]
                 key = natsort_keygen(
-                    key=lambda s: s.meta.get(meta_key, [""])[0], alg=ns.LOCALE
+                    key=lambda s: s.meta.get(meta_key, [""])[0],
+                    alg=ns.SIGNED | ns.LOCALE,
                 )
             else:
                 key = natsort_keygen(
-                    key=lambda s: getattr(s, medias_sort_attr), alg=ns.LOCALE
+                    key=lambda s: getattr(s, medias_sort_attr),
+                    alg=ns.SIGNED | ns.LOCALE,
                 )
 
             self.medias.sort(key=key, reverse=self.settings["medias_sort_reverse"])
@@ -734,6 +743,11 @@ class Gallery:
                 fnmatch.fnmatch(relpath, ignore) for ignore in ignore_dirs
             ):
                 self.logger.info("Ignoring %s", relpath)
+                # Remove sub-directories
+                for d in dirs[:]:
+                    path = join(relpath, d) if relpath != "." else d
+                    if path in albums.keys():
+                        del albums[path]
                 continue
 
             # Remove files that match the ignore_files settings
@@ -767,7 +781,7 @@ class Gallery:
 
         with progressbar(
             albums.values(),
-            label="%16s" % "Sorting albums",
+            label="{:>16s}".format("Sorting albums"),
             file=self.progressbar_target,
         ) as progress_albums:
             for album in progress_albums:
@@ -775,7 +789,7 @@ class Gallery:
 
         with progressbar(
             albums.values(),
-            label="%16s" % "Sorting media",
+            label="{:>16s}".format("Sorting medias"),
             file=self.progressbar_target,
         ) as progress_albums:
             for album in progress_albums:
@@ -891,12 +905,13 @@ class Gallery:
 
         if self.settings["write_html"]:
             album_writer = AlbumPageWriter(self.settings, index_title=self.title)
+            album_writer.copy_theme_files()
             album_list_writer = AlbumListPageWriter(
                 self.settings, index_title=self.title
             )
             with progressbar(
                 self.albums.values(),
-                label="%16s" % "Writing files",
+                label="{:>16s}".format("Writing files"),
                 item_show_func=log_func,
                 show_eta=False,
                 file=self.progressbar_target,

sigal/image.py

@@ -44,11 +44,21 @@ from PIL.TiffImagePlugin import IFDRational
 from pilkit.processors import Transpose
 from pilkit.utils import save_image
 
+try:
+    from pillow_heif import HeifImagePlugin  # noqa: F401
+
+    HAS_HEIF = True
+except ImportError:
+    HAS_HEIF = False
+
 from . import signals, utils
+from .settings import Status
 
 # Force loading of truncated files
 ImageFile.LOAD_TRUNCATED_IMAGES = True
 
+EXIF_EXTENSIONS = (".jpg", ".jpeg", ".heic")
+
 
 def _has_exif_tags(img):
     return hasattr(img, "info") and "exif" in img.info
@@ -66,8 +76,7 @@ def _read_image(file_path):
 
     for w in caught_warnings:
         logger.warning(
-            f"PILImage reported a warning for file {file_path}\n"
-            f"{w.category}: {w.message}"
+            f"Pillow reported a warning for file {file_path}\n{w.category}: {w.message}"
         )
     return im
 
@@ -180,6 +189,11 @@ def process_image(media):
         options = media.settings["jpg_options"]
     elif media.src_ext == ".png":
         options = {"optimize": True}
+    elif media.src_ext == ".heic" and not HAS_HEIF:
+        logger.warning(
+            f"cannot open {media.src_path}, pillow-heif is needed to open .heic files"
+        )
+        return Status.FAILURE
     else:
         options = {}
 
@@ -220,7 +234,10 @@ def get_exif_data(filename):
 
     try:
         with warnings.catch_warnings(record=True) as caught_warnings:
-            exif = img._getexif() or {}
+            exif = {}
+            exifdata = img.getexif()
+            if exifdata:
+                exif = exifdata._get_merged_dict()
     except ZeroDivisionError:
         logger.warning("Failed to read EXIF data.")
         return None
@@ -290,7 +307,7 @@ def get_image_metadata(filename):
         logger.error("Could not open image %s metadata: %s", filename, e)
     else:
         try:
-            if os.path.splitext(filename)[1].lower() in (".jpg", ".jpeg"):
+            if os.path.splitext(filename)[1].lower() in EXIF_EXTENSIONS:
                 exif = get_exif_data(img)
         except Exception as e:
             logger.warning("Could not read EXIF data from %s: %s", filename, e)

sigal/plugins/compress_assets.py

@@ -106,9 +106,10 @@ class GZipCompressor(BaseCompressor):
     suffix = "gz"
 
     def do_compress(self, filename, compressed_filename):
-        with open(filename, "rb") as f_in, gzip.open(
-            compressed_filename, "wb"
-        ) as f_out:
+        with (
+            open(filename, "rb") as f_in,
+            gzip.open(compressed_filename, "wb") as f_out,
+        ):
             shutil.copyfileobj(f_in, f_out)
 
 

sigal/plugins/encrypt/encrypt.py

@@ -200,7 +200,7 @@ def encrypt_files(settings, config, cache, albums, progressbar_target):
     medias = list(chain.from_iterable(albums.values()))
     with progressbar(
         medias,
-        label="%16s" % "Encrypting files",
+        label="{:>16s}".format("Encrypting files"),
         file=progressbar_target,
         show_eta=True,
     ) as medias:

sigal/plugins/encrypt/endec.py

@@ -66,7 +66,7 @@ def dispatchargs(decorated):
 
 def encrypt(key: bytes, infile: BinaryIO, outfile: BinaryIO, tag: bytes):
     if len(key) != 128 / 8:
-        raise ValueError("Unsupported key length: %d" % len(key))
+        raise ValueError(f"Unsupported key length: {len(key)}")
     aesgcm = AESGCM(key)
     iv = os.urandom(12)
     plaintext = infile
@@ -80,7 +80,7 @@ def encrypt(key: bytes, infile: BinaryIO, outfile: BinaryIO, tag: bytes):
 
 def decrypt(key: bytes, infile: BinaryIO, outfile: BinaryIO, tag: bytes):
     if len(key) != 128 / 8:
-        raise ValueError("Unsupported key length: %d" % len(key))
+        raise ValueError(f"Unsupported key length: {len(key)}")
     aesgcm = AESGCM(key)
     ciphertext = infile
     plaintext = outfile

sigal/plugins/extended_caching.py

@@ -18,7 +18,7 @@
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 # IN THE SOFTWARE.
 
-""" Decreases the time needed to build large galleries (e.g.: 25k images in
+"""Decreases the time needed to build large galleries (e.g.: 25k images in
 2.5s instead of 30s)
 
 This plugin allows extended caching, which is useful for large galleries. Once
@@ -78,6 +78,8 @@ def load_metadata(album):
                 media.file_metadata = data["file_metadata"]
             if "exif" in data:
                 media.exif = data["exif"]
+            if "input_size" in data:
+                media.input_size = data["input_size"]
 
             try:
                 mod_date = int(get_mod_date(media.markdown_metadata_filepath))
@@ -134,6 +136,8 @@ def save_cache(gallery):
                 data["file_metadata"] = media.file_metadata
                 if hasattr(media, "exif"):
                     data["exif"] = media.exif
+                if hasattr(media, "input_size"):
+                    data["input_size"] = media.input_size
 
             try:
                 meta_mod_date = int(get_mod_date(media.markdown_metadata_filepath))

sigal/plugins/nomedia.py

@@ -18,7 +18,7 @@
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 # IN THE SOFTWARE.
 
-""" This plugin offers more fine-grained control over exluded images and
+"""This plugin offers more fine-grained control over exluded images and
 folders, similarly to how it's handled on Android.
 
 To ignore a folder or image put a ``.nomedia`` file next to it in its parent

sigal/plugins/titleregexp.py

@@ -18,7 +18,7 @@
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 # IN THE SOFTWARE.
 
-""" This plugin modifies titles of galleries by using regular-expressions and
+"""This plugin modifies titles of galleries by using regular-expressions and
 simple string or character replacements. It is acting in two phases: First, all
 regular-expression-based modifications are carried out, second, string/character
 replacements are done.
@@ -74,7 +74,7 @@ def titleregexp(album):
 
     for r in cfg.get("regexp"):
         album.title, n = re.subn(
-            r.get("search"), r.get("replace"), album.title, r.get("count", 0)
+            r.get("search"), r.get("replace"), album.title, count=r.get("count", 0)
         )
         total += n
 

sigal/plugins/zip_gallery.py

@@ -18,7 +18,7 @@
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 # IN THE SOFTWARE.
 
-""" This plugin controls the generation of a ZIP archive for a gallery
+"""This plugin controls the generation of a ZIP archive for a gallery
 
 If the ``zip_gallery`` setting is set, it contains the location of a zip
 archive with all original images of the corresponding directory.

sigal/settings.py

@@ -30,9 +30,11 @@ _DEFAULT_CONFIG = {
     "albums_sort_attr": "name",
     "albums_sort_reverse": False,
     "autorotate_images": True,
+    "autoplay": False,
     "colorbox_column_size": 3,
     "copy_exif_data": False,
     "datetime_format": "%c",
+    "display_timestamp": False,
     "destination": "_build",
     "files_to_copy": (),
     "galleria_theme": "classic",
@@ -40,7 +42,16 @@ _DEFAULT_CONFIG = {
     "google_tag_manager": "",
     "ignore_directories": [],
     "ignore_files": [],
-    "img_extensions": [".jpg", ".jpeg", ".png", ".gif", ".tif", ".tiff", ".webp"],
+    "img_extensions": [
+        ".jpg",
+        ".jpeg",
+        ".png",
+        ".gif",
+        ".heic",
+        ".tif",
+        ".tiff",
+        ".webp",
+    ],
     "img_processor": "ResizeToFit",
     "img_size": (640, 480),
     "img_format": None,

sigal/templates/sigal.conf.py

@@ -39,6 +39,9 @@ theme = "galleria"
 # Path to a CSS file that can be used to customize themes
 # user_css =
 
+# Enable autoplay (galleria only)
+# autoplay = False
+
 # ----------------
 # Image processing (ignored if use_orig = True)
 # ----------------
@@ -63,7 +66,7 @@ img_size = (800, 600)
 # map_height = '500px'
 
 # File extensions that should be treated as images
-# img_extensions = ['.jpg', '.jpeg', '.png', '.gif']
+# img_extensions = [".jpg", ".jpeg", ".png", ".gif", ".heic", ".tif", ".tiff", ".webp"]
 
 # Pilkit processor used to resize the image
 # (see http://pilkit.readthedocs.org/en/latest/#processors)
@@ -86,6 +89,9 @@ img_size = (800, 600)
 # https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior
 # datetime_format = '%c'
 
+# Display generated datetime in the resulting output
+# display_timestamp = False
+
 # Jpeg options
 # jpg_options = {'quality': 85,
 #                'optimize': True,
@@ -128,7 +134,7 @@ thumb_size = (280, 210)
 # thumb_video_black_max_colors = 4
 
 # Keep original image (default: False)
-# keep_orig = True
+# keep_orig = False
 
 # Subdirectory for original images
 # orig_dir = 'original'
@@ -158,7 +164,7 @@ thumb_size = (280, 210)
 # Filter directories and files.
 # The settings take a list of patterns matched with the fnmatch module on the
 # path relative to the source directory:
-# http://docs.python.org/2/library/fnmatch.html
+# http://docs.python.org/3/library/fnmatch.html
 ignore_directories = []
 ignore_files = []
 
@@ -281,7 +287,6 @@ ignore_files = []
 #     'sigal.plugins.media_page',
 #     'sigal.plugins.nomedia',
 #     'sigal.plugins.nonmedia_files',
-#     'sigal.plugins.upload_s3',
 #     'sigal.plugins.watermark',
 #     'sigal.plugins.zip_gallery',
 # ]
@@ -317,13 +322,6 @@ ignore_files = []
 #     'thumb_font_size': 40, # only applies when a font is selected
 # }
 
-# Settings for upload to s3 plugin
-# upload_s3_options = {
-# 	'bucket': 'my-bucket',
-# 	'policy': 'public-read',
-# 	'overwrite': False
-# }
-
 # Set zip_gallery to either False or a file name. The file name can
 # be formatted python style with an 'album' variable, for example
 # '{album.name}.zip'. The final archive will contain all resized or

sigal/themes/default/templates/description.html

@@ -0,0 +1,29 @@
+{% macro img_description(media, with_big=True) -%}
+  {%- if with_big and media.big -%}
+    <a href='{{ media.big_url }}'>Full size</a>
+  {%- endif -%}
+  {%- if media.description -%}
+    <br>{{ media.description }}
+  {%- endif -%}
+  {%- if media.exif -%}
+    <div class='film-meta'>
+      {%- if media.exif.iso -%}
+        <abbr title='film speed'>{{ media.exif.iso }}</abbr> {%- endif -%}
+      {%- if media.exif.exposure -%}
+        <abbr title='exposure'>{{ media.exif.exposure }}</abbr> {%- endif -%}
+      {%- if media.exif.fstop -%}
+        <abbr title='aperture'>{{ media.exif.fstop }}</abbr> {%- endif -%}
+      {%- if media.exif.focal -%}
+        <abbr title='focal length'>{{ media.exif.focal }}</abbr> {%- endif -%}
+    </div>
+    {%- if media.exif.gps -%}
+      <a title='location' href='https://www.openstreetmap.org/?mlat={{ media.exif.gps.lat }}&amp;mlon={{ media.exif.gps.lon}}&amp;zoom=12&amp;layers=M' target='_blank' class='map' >{{ 'N{:.6f}'.format(media.exif.gps.lat) if media.exif.gps.lat > 0 else 'S{:.6f}'.format(-media.exif.gps.lat) }}{{ 'E{:.6f}'.format(media.exif.gps.lon) if media.exif.gps.lon > 0 else 'W{:.6f}'.format(-media.exif.gps.lon) }}</a>
+    {%- endif -%}
+    {%- if media.exif.Make or media.exif.Model -%}
+      <abbr title='camera make and model'>{{ media.exif.Make }} {{ media.exif.Model }}</abbr>
+    {%- endif -%}
+    {%- if media.exif.datetime -%}
+      <abbr title='date'>{{ media.exif.datetime }}</abbr>
+    {%- endif -%}
+  {% endif %}
+{%- endmacro %}

sigal/themes/default/templates/footer.html

@@ -12,5 +12,8 @@
         <span><a href={{ settings.atom_feed.feed_url }}>Atom Feed</a></span>
       {% endif %}
     {% endif %}
+    {% if settings.display_timestamp %}
+        @ {{ generated_timestamp }}
+    {% endif %}
   </p>
 </footer>

sigal/themes/galleria/templates/album_items.html

@@ -1,3 +1,4 @@
+{% from 'description.html' import img_description %}
 <div class="icons">
   <a id="fullscreen"><img src="{{ theme.url }}/img/fullscreen.png"
                           title="Fullscreen" alt="Fullscreen (f)" /></a>
@@ -17,29 +18,6 @@
 
 {% block late_js %}
   {% if album.medias %}
-    {% macro img_description(media) -%}
-      {%- if media.big -%}<a href='{{ media.big_url }}'>Full size</a>{%- endif -%}
-      {# clean up tags and whitespace, including newlines, in the description #}
-      {%- if media.description -%}<br>{{ media.description | striptags }}{%- endif -%}
-      {%- if media.exif -%}
-        <div class='film-meta'>
-        {%- if media.exif.iso -%}<abbr title='film speed'>{{ media.exif.iso }}</abbr> {%- endif -%}
-        {%- if media.exif.exposure -%}<abbr title='exposure'>{{ media.exif.exposure }}</abbr> {%- endif -%}
-        {%- if media.exif.fstop -%}<abbr title='aperture'>{{ media.exif.fstop }}</abbr> {%- endif -%}
-        {%- if media.exif.focal -%}<abbr title='focal length'>{{ media.exif.focal }}</abbr> {%- endif -%}
-        </div>
-        {%- if media.exif.gps -%}
-          <a title='location' href='https://www.openstreetmap.org/?mlat={{ media.exif.gps.lat }}&amp;mlon={{ media.exif.gps.lon}}&amp;zoom=12&amp;layers=M' target='_blank' class='map' >{{ 'N{:.6f}'.format(media.exif.gps.lat) if media.exif.gps.lat > 0 else 'S{:.6f}'.format(-media.exif.gps.lat) }}{{ 'E{:.6f}'.format(media.exif.gps.lon) if media.exif.gps.lon > 0 else 'W{:.6f}'.format(-media.exif.gps.lon) }}</a>
-        {%- endif -%}
-        {%- if media.exif.Make or media.exif.Model -%}
-          <abbr title='camera make and model'>{{ media.exif.Make }} {{ media.exif.Model }}</abbr>
-        {%- endif -%}
-        {%- if media.exif.datetime -%}
-          <abbr title='date'>{{ media.exif.datetime }}</abbr>
-        {%- endif -%}
-      {% endif %}
-    {%- endmacro %}
-
     <script src="{{ theme.url }}/jquery-3.3.1.min.js"></script>
     <script src="{{ theme.url }}/galleria.min.js"></script>
     <script src="{{ theme.url }}/themes/{{ settings.galleria_theme }}/galleria.{{ settings.galleria_theme }}.min.js"></script>
@@ -93,6 +71,7 @@
     });
 
     Galleria.configure({
+        {% if settings.autoplay %}autoplay: true,{% endif %}
         imageCrop: false,
         transition: "fade",
         thumbnails: "lazy"