crieur 1.5.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

crieur/__init__.py

@@ -1,4 +1,4 @@
 from pathlib import Path
 
-VERSION = "1.5.0"
+VERSION = "1.7.0"
 ROOT_DIR = Path(__file__).parent

crieur/cli.py

@@ -27,6 +27,7 @@ def generate(
     extra_vars: str = "",
     target_path: Path = Path() / "public",
     source_path: Path = Path() / "sources",
+    statics_path: Path = Path(__file__).parent / "statics",
     templates_path: Path = Path(__file__).parent / "templates",
     without_statics: bool = False,
     feed_limit: int = 10,
@@ -38,6 +39,7 @@ def generate(
     :extra_vars: stringified JSON extra vars passed to the templates.
     :target_path: Path where site is built (default: /public/).
     :source_path: Path where stylo source were downloaded (default: /sources/).
+    :statics_path: Path where statics are located (default: @crieur/statics/).
     :template_path: Path where templates are located (default: @crieur/templates/).
     :without_statics: Do not copy statics if True (default: False).
     :feed_limit: Number of max items in the feed (default: 10).
@@ -45,7 +47,7 @@ def generate(
     numeros = []
     for numero in each_folder_from(source_path):
         for corpus_yaml in each_file_from(numero, pattern="*.yaml"):
-            numero = configure_numero(corpus_yaml)
+            numero = configure_numero(corpus_yaml, base_url)
             numeros.append(numero)
 
     keywords = collect_keywords(numeros)
@@ -63,8 +65,7 @@ def generate(
     generate_feed(title, base_url, numeros, extra_vars, target_path, number=feed_limit)
 
     if not without_statics:
-        static_path_local = Path(__file__).parent / "statics"
-        shutil.copytree(static_path_local, target_path / "statics", dirs_exist_ok=True)
+        shutil.copytree(statics_path, target_path / "statics", dirs_exist_ok=True)
 
 
 @cli

crieur/generator.py

@@ -2,6 +2,7 @@ import json
 import locale
 import shutil
 from datetime import datetime, timedelta, timezone
+from pathlib import Path
 
 import mistune
 from feedgen.feed import FeedGenerator
@@ -27,7 +28,11 @@ def markdown(value):
 def generate_html(
     title, base_url, numeros, keywords, authors, extra_vars, target_path, templates_path
 ):
-    environment = Env(loader=FileSystemLoader(str(templates_path)))
+    environment = Env(
+        loader=FileSystemLoader(
+            [str(templates_path), str(Path(__file__).parent / "templates")]
+        )
+    )
     environment.filters["slugify"] = slugify_
     environment.filters["markdown"] = markdown
 
@@ -113,7 +118,7 @@ def generate_feed(title, base_url, numeros, extra_vars, target_path, number, lan
         )
         for author in article.authors:
             feed_entry.author(name=str(author))
-        feed_entry.summary(summary=md(article.content_md), type="html")
+        feed_entry.summary(summary=article.content_html, type="html")
         if article.keywords:
             for keyword in article.keywords:
                 feed_entry.category(term=keyword.name)

crieur/models.py

@@ -1,13 +1,67 @@
 from dataclasses import dataclass
 from datetime import datetime
+from textwrap import dedent
 from typing import Optional
 
+import mistune
 from dataclass_wizard import DatePattern, DumpMeta, YAMLWizard
 from dataclass_wizard import errors as dw_errors
+from PIL import Image, UnidentifiedImageError
 from slugify import slugify
 from yaml.composer import ComposerError
 
 
+class ImgsWithSizesRenderer(mistune.HTMLRenderer):
+    """Renders images as <figure>s and add sizes."""
+
+    def __init__(
+        self,
+        escape=True,
+        allow_harmful_protocols=None,
+        base_url=None,
+        article=None,
+    ):
+        super().__init__()
+        self._base_url = base_url
+        self._article = article
+
+    def paragraph(self, text):
+        # In case of a figure, we do not want the (non-standard) paragraph.
+        if text.strip().startswith("<figure>"):
+            return text
+        return super().paragraph(text)
+
+    def image(self, alt, url):
+        if self._article.images_path is None:
+            print(f"Image with URL `{url}` is discarded.")
+            return ""
+        full_path = self._article.images_path.resolve().parent / url
+        try:
+            image = Image.open(full_path)
+        except (IsADirectoryError, FileNotFoundError, UnidentifiedImageError):
+            print(f"`{full_path}` is not a valid image.")
+            return ""
+        width, height = image.size
+        caption = f"<figcaption>{alt}</figcaption>" if alt else ""
+        full_url = f"{self._base_url}{self._article.url}{url}"
+        return dedent(
+            f"""\
+            <figure>
+                <a href="{full_url}"
+                    title="Cliquer pour une version haute résolution">
+                    <img
+                        src="{full_url}"
+                        width="{width}" height="{height}"
+                        loading="lazy"
+                        decoding="async"
+                        alt="{alt}">
+                </a>
+                {caption}
+            </figure>
+            """
+        )
+
+
 @dataclass
 class Numero(YAMLWizard):
     _id: str
@@ -19,7 +73,7 @@ class Numero(YAMLWizard):
     def __post_init__(self):
         self.slug = slugify(self.name)
 
-    def configure_articles(self, yaml_path):
+    def configure_articles(self, yaml_path, base_url):
         # Preserves abstract_fr key (vs. abstract-fr) when converting to_yaml()
         DumpMeta(key_transform="SNAKE").bind_to(Article)
 
@@ -61,6 +115,15 @@ class Numero(YAMLWizard):
                 else None
             )
             loaded_article.numero = self
+            md = mistune.create_markdown(
+                renderer=ImgsWithSizesRenderer(
+                    escape=False,
+                    base_url=base_url,
+                    article=loaded_article,
+                ),
+                plugins=["footnotes", "superscript"],
+            )
+            loaded_article.content_html = md(loaded_article.content_md)
             loaded_articles.append(loaded_article)
         self.articles = sorted(loaded_articles, reverse=True)
 
@@ -94,7 +157,7 @@ class Article(YAMLWizard):
         return f"numero/{self.numero.slug}/article/{self.id}/"
 
 
-def configure_numero(yaml_path):
+def configure_numero(yaml_path, base_url):
     # Preserves abstract_fr key (vs. abstract-fr) when converting to_yaml()
     DumpMeta(key_transform="SNAKE").bind_to(Numero)
 
@@ -103,7 +166,7 @@ def configure_numero(yaml_path):
     except ComposerError:
         numero = Numero.from_yaml(yaml_path.read_text().split("---")[1])
 
-    numero.configure_articles(yaml_path)
+    numero.configure_articles(yaml_path, base_url)
     return numero
 
 

crieur/templates/article.html

@@ -34,7 +34,7 @@
         {% endfor %}
       {% endif %}
 
-      {{ article.content_md|markdown }}
+      {{ article.content_html }}
     </div>
   </article>
 {% endblock content %}

{crieur-1.5.0.dist-info → crieur-1.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crieur
-Version: 1.5.0
+Version: 1.7.0
 Summary: A Static Revue Generator.
 Project-URL: Homepage, https://gitlab.huma-num.fr/ecrinum/crieur
 Project-URL: Issues, https://gitlab.huma-num.fr/ecrinum/crieur/-/issues
@@ -689,6 +689,7 @@ Requires-Dist: httpx
 Requires-Dist: jinja2
 Requires-Dist: minicli
 Requires-Dist: mistune
+Requires-Dist: pillow
 Requires-Dist: python-slugify
 Requires-Dist: pytz>=2025.2
 Requires-Dist: pyyaml>=6.0.2
@@ -753,6 +754,7 @@ cog.out(f"```\n{help}\n```")
 ```
                        [--extra-vars EXTRA_VARS] [--target-path TARGET_PATH]
                        [--source-path SOURCE_PATH]
+                       [--statics-path STATICS_PATH]
                        [--templates-path TEMPLATES_PATH] [--without-statics]
                        [--feed-limit FEED_LIMIT]
 
@@ -767,6 +769,9 @@ options:
   --source-path SOURCE_PATH
                         Path where stylo source were downloaded (default:
                         /sources/).
+  --statics-path STATICS_PATH
+                        Path where statics are located (default:
+                        @crieur/statics/).
   --templates-path TEMPLATES_PATH
   --without-statics     Do not copy statics if True (default: False).
   --feed-limit FEED_LIMIT

{crieur-1.5.0.dist-info → crieur-1.7.0.dist-info}/RECORD

@@ -1,18 +1,18 @@
-crieur/__init__.py,sha256=E991QFU_-kmyKseQrDTcr_YjRxyBnwSe8uXpcBu-Yw8,77
+crieur/__init__.py,sha256=I-oN_DJHUd7dkTJ8uqE26Pn84CyxcOXovlL7I7N4yNE,77
 crieur/__main__.py,sha256=bYt9eEaoRQWdejEHFD8REx9jxVEdZptECFsV7F49Ink,30
-crieur/cli.py,sha256=JASr1HoM6vx7ZRi3vdY6NVKqHxcNerKc0Bklnoex6HU,5727
-crieur/generator.py,sha256=MURqkacHmqj8MpC6loQqrKQOk-lEYrknH-p8rFPCTmw,4388
-crieur/models.py,sha256=Dc7zxYAEFM7MCm5RKu8NdN272FOSWCgwurpZ5rqSKp4,6566
+crieur/cli.py,sha256=trYYSwcYsyPoWluZSVLoSA-8w86uQy3Wnw_w6724g8k,5809
+crieur/generator.py,sha256=WeDqYNnAhkauBrY4R5zNXfWfYdDS73HdSeFcLEKmZU0,4491
+crieur/models.py,sha256=KrW6gy7z0RzDBdUAd2VgwzcNkMOpdRPnu9JxvkNGZ8c,8727
 crieur/utils.py,sha256=kIdxpd5LgVv13Lx2aEXzjQttBDtcppRlwNsH0vwX8f0,1566
 crieur/statics/pico.css,sha256=VdrimW9PLcEIzqJ__s062OrwBj_Jb6jZIwbtdqOtM-w,93407
-crieur/templates/article.html,sha256=4Y1sjBR1nM_ff4yVGgiVlZU1tmnfBMXAjTTSAhqoiA4,1288
+crieur/templates/article.html,sha256=AgqMIM0HG9IDFZ8tArsCLgbLmx86oY-HC6Jj2lgzUMg,1281
 crieur/templates/author.html,sha256=1VHZi6Wld1gWYPfeW3cEJ2ULOKrp9xoCVRhDjPUDdHg,420
 crieur/templates/base.html,sha256=4ZOLAnmle0_m8Y3lWT6wcH8f-_7SymxEDeIUzDQNnks,1626
 crieur/templates/homepage.html,sha256=7YG7kA4AFuyrSuqWeFAVj09ogwsybE7w0-NKMLWms5s,2994
 crieur/templates/keyword.html,sha256=Hv3Ep3R6oN5pBw14gfQT-aeqEiuFiatmVZLWn5hR1e4,428
 crieur/templates/numero.html,sha256=F7hCaAHJ1WRWxD_zfhJzyLaiwXblJWJF7DUTy41Mnu8,1849
-crieur-1.5.0.dist-info/METADATA,sha256=ICGtHO0FWF7N8rdSRTDv5QKCIlxZkoiaNbxpP4VJiqQ,45024
-crieur-1.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-crieur-1.5.0.dist-info/entry_points.txt,sha256=edmbmPxs9QXyvSMpPJBDPGw3vZOJEKqXJhysYNx3QSM,43
-crieur-1.5.0.dist-info/licenses/LICENSE,sha256=F5acw9_laHeyi4wPmQyf_ttyz81VqCIwScwO8C1FhXU,34519
-crieur-1.5.0.dist-info/RECORD,,
+crieur-1.7.0.dist-info/METADATA,sha256=pRi6qHf6g3NveR_--Or1AuMCMEOfTXL0pay7A_PyqEc,45237
+crieur-1.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+crieur-1.7.0.dist-info/entry_points.txt,sha256=edmbmPxs9QXyvSMpPJBDPGw3vZOJEKqXJhysYNx3QSM,43
+crieur-1.7.0.dist-info/licenses/LICENSE,sha256=F5acw9_laHeyi4wPmQyf_ttyz81VqCIwScwO8C1FhXU,34519
+crieur-1.7.0.dist-info/RECORD,,