crieur 1.0.5__tar.gz → 1.2.0__tar.gz

{crieur-1.0.5 → crieur-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crieur
-Version: 1.0.5
+Version: 1.2.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
@@ -750,17 +750,23 @@ help = output.decode().split("\n", 1)[1]  # Remove Pandoc version.
 cog.out(f"```\n{help}\n```")
 ]]] -->
 ```
-                       [--target-path TARGET_PATH] [--source-path SOURCE_PATH]
+                       [--extra-vars EXTRA_VARS] [--target-path TARGET_PATH]
+                       [--source-path SOURCE_PATH]
+                       [--templates-path TEMPLATES_PATH] [--without-statics]
 
 options:
   -h, --help            show this help message and exit
   --title, -t TITLE     Title of the website (default: Crieur).
   --base-url BASE_URL   Base URL of the website, ending with / (default: /).
+  --extra-vars EXTRA_VARS
+                        stringified JSON extra vars passed to the templates.
   --target-path TARGET_PATH
                         Path where site is built (default: /public/).
   --source-path SOURCE_PATH
                         Path where stylo source were downloaded (default:
                         /sources/).
+  --templates-path TEMPLATES_PATH
+  --without-statics     Do not copy statics if True (default: False).
 
 ```
 <!-- [[[end]]] -->

{crieur-1.0.5 → crieur-1.2.0}/README.md

@@ -46,17 +46,23 @@ help = output.decode().split("\n", 1)[1]  # Remove Pandoc version.
 cog.out(f"```\n{help}\n```")
 ]]] -->
 ```
-                       [--target-path TARGET_PATH] [--source-path SOURCE_PATH]
+                       [--extra-vars EXTRA_VARS] [--target-path TARGET_PATH]
+                       [--source-path SOURCE_PATH]
+                       [--templates-path TEMPLATES_PATH] [--without-statics]
 
 options:
   -h, --help            show this help message and exit
   --title, -t TITLE     Title of the website (default: Crieur).
   --base-url BASE_URL   Base URL of the website, ending with / (default: /).
+  --extra-vars EXTRA_VARS
+                        stringified JSON extra vars passed to the templates.
   --target-path TARGET_PATH
                         Path where site is built (default: /public/).
   --source-path SOURCE_PATH
                         Path where stylo source were downloaded (default:
                         /sources/).
+  --templates-path TEMPLATES_PATH
+  --without-statics     Do not copy statics if True (default: False).
 
 ```
 <!-- [[[end]]] -->

{crieur-1.0.5 → crieur-1.2.0}/crieur/__init__.py

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

{crieur-1.0.5 → crieur-1.2.0}/crieur/cli.py

@@ -22,17 +22,23 @@ def version():
 
 @cli
 def generate(
-    title="Crieur",
-    base_url="/",
+    title: str = "Crieur",
+    base_url: str = "/",
+    extra_vars: str = "",
     target_path: Path = Path() / "public",
     source_path: Path = Path() / "sources",
+    templates_path: Path = Path(__file__).parent / "templates",
+    without_statics: bool = False,
 ):
     """Generate a new revue website.
 
     :title: Title of the website (default: Crieur).
     :base_url: Base URL of the website, ending with / (default: /).
+    :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/).
+    :template_path: Path where templates are located (default: @crieur/templates/).
+    :without_statics: Do not copy statics if True (default: False).
     """
     numeros = []
     for numero in each_folder_from(source_path):
@@ -41,10 +47,13 @@ def generate(
             numeros.append(numero)
 
     keywords = collect_keywords(numeros)
-    generate_html(title, base_url, numeros, keywords, target_path)
+    generate_html(
+        title, base_url, numeros, keywords, extra_vars, target_path, templates_path
+    )
 
-    static_path_local = Path(__file__).parent / "statics"
-    shutil.copytree(static_path_local, target_path / "statics", dirs_exist_ok=True)
+    if not without_statics:
+        static_path_local = Path(__file__).parent / "statics"
+        shutil.copytree(static_path_local, target_path / "statics", dirs_exist_ok=True)
 
 
 @cli

{crieur-1.0.5 → crieur-1.2.0}/crieur/generator.py

@@ -1,40 +1,43 @@
+import json
 import locale
 import shutil
-from pathlib import Path
 
 import mistune
 from jinja2 import Environment as Env
 from jinja2 import FileSystemLoader
 from slugify import slugify
 
+from . import VERSION
 from .utils import neighborhood
 
 locale.setlocale(locale.LC_ALL, "")
-environment = Env(loader=FileSystemLoader(str(Path(__file__).parent / "templates")))
+md = mistune.create_markdown(plugins=["footnotes", "superscript"])
 
 
 def slugify_(value):
     return slugify(value)
 
 
-environment.filters["slugify"] = slugify_
-
-md = mistune.create_markdown(plugins=["footnotes", "superscript"])
-
-
 def markdown(value):
     return md(value) if value else ""
 
 
-environment.filters["markdown"] = markdown
+def generate_html(
+    title, base_url, numeros, keywords, extra_vars, target_path, templates_path
+):
+    environment = Env(loader=FileSystemLoader(str(templates_path)))
+    environment.filters["slugify"] = slugify_
+    environment.filters["markdown"] = markdown
 
+    extra_vars = json.loads(extra_vars) if extra_vars else {}
 
-def generate_html(title, base_url, numeros, keywords, target_path):
     common_params = {
         "title": title,
         "base_url": base_url,
         "numeros": numeros,
         "keywords": keywords,
+        "crieur_version": VERSION,
+        **extra_vars,
     }
 
     template_homepage = environment.get_template("homepage.html")
@@ -45,7 +48,7 @@ def generate_html(title, base_url, numeros, keywords, target_path):
     for numero in numeros:
         template_numero = environment.get_template("numero.html")
         content = template_numero.render(numero=numero, **common_params)
-        numero_folder = target_path / "numero" / numero.name
+        numero_folder = target_path / "numero" / numero.slug
         numero_folder.mkdir(parents=True, exist_ok=True)
         (numero_folder / "index.html").write_text(content)
 

{crieur-1.0.5 → crieur-1.2.0}/crieur/models.py

@@ -14,6 +14,9 @@ class Numero(YAMLWizard):
     metadata: str
     articles: list
 
+    def __post_init__(self):
+        self.slug = slugify(self.name)
+
     def configure_articles(self, yaml_path):
         # Preserves abstract_fr key (vs. abstract-fr) when converting to_yaml()
         DumpMeta(key_transform="SNAKE").bind_to(Article)
@@ -50,15 +53,18 @@ class Numero(YAMLWizard):
 class Article(YAMLWizard):
     title: str
     title_f: str
-    date: Optional[DatePattern["%Y/%m/%d"]]  # noqa: F722
     id: str = ""
     subtitle: str = ""
     subtitle_f: str = ""
     content_md: str = ""
+    date: Optional[DatePattern["%Y/%m/%d"]] = None  # noqa: F722
     authors: list = None
     abstract: list = None
     keywords: list = None
 
+    def __post_init__(self):
+        self.slug = slugify(self.title)
+
 
 def configure_numero(yaml_path):
     # Preserves abstract_fr key (vs. abstract-fr) when converting to_yaml()

{crieur-1.0.5 → crieur-1.2.0}/crieur/templates/article.html

@@ -1,7 +1,7 @@
 {% extends "base.html" %}
 
 {% block content %}
-  <h2><a href="{{ base_url }}numeros/{{ numero.name }}">{{ numero.name }}</a></h2>
+  <h2><a href="{{ base_url }}numero/{{ numero.slug }}/">{{ numero.name }}</a></h2>
 
   <article>
     <header>

{crieur-1.0.5 → crieur-1.2.0}/crieur/templates/base.html

@@ -4,6 +4,7 @@
   <!-- Has to be within the first 1024 bytes, hence before the <title>
   See: https://www.w3.org/TR/2012/CR-html5-20121217/document-metadata.html#charset -->
   <meta charset="utf-8" />
+  <meta name="generator" content="Crieur {{ crieur_version }}">
   <!-- Why no `X-UA-Compatible` meta: https://stackoverflow.com/a/6771584 -->
   <!-- The viewport meta is quite crowded and we are responsible for that.
   See: https://codepen.io/tigt/post/meta-viewport-for-2015 -->

{crieur-1.0.5 → crieur-1.2.0}/crieur/templates/homepage.html

@@ -75,13 +75,13 @@
     <article>
       <header>
         <hgroup>
-          <h2><a href="{{ base_url }}numero/{{ numero.name }}/">{{ numero.name }}</a></h2>
+          <h2><a href="{{ base_url }}numero/{{ numero.slug }}/">{{ numero.name }}</a></h2>
           <p>Le {{ numero.articles.0.date.strftime('%d %B %Y') }}</p>
         </hgroup>
       </header>
       <ul>
         {% for article in numero.articles %}
-          <li><a href="{{ base_url }}numero/{{ numero.name }}/article/{{ article.id }}/">{{ article.title_f }}</a></li>
+          <li><a href="{{ base_url }}numero/{{ numero.slug }}/article/{{ article.id }}/">{{ article.title_f }}</a></li>
         {% endfor %}
       </ul>
     </article>

{crieur-1.0.5 → crieur-1.2.0}/crieur/templates/keyword.html

@@ -9,7 +9,7 @@
     <div>
       <ul>
         {% for article in keyword.articles %}
-          <li><a href="{{ base_url }}numero/{{ article.numero.name }}/article/{{ article.id }}/">{{ article.title_f }}</a></li>
+          <li><a href="{{ base_url }}numero/{{ article.numero.slug }}/article/{{ article.id }}/">{{ article.title_f }}</a></li>
         {% endfor %}
       </ul>
     </div>

{crieur-1.0.5 → crieur-1.2.0}/crieur/templates/numero.html

@@ -59,7 +59,7 @@
   {% for article in numero.articles %}
     <article>
       <header>
-        <h3><a href="{{ base_url }}numero/{{ numero.name }}/article/{{ article.id }}/">{{ article.title_f }}</a></h3>
+        <h3><a href="{{ base_url }}numero/{{ numero.slug }}/article/{{ article.id }}/">{{ article.title_f }}</a></h3>
       </header>
       {{ article.subtitle_f|markdown }}
       {% if article.authors %}