crieur 1.0.4__tar.gz → 1.1.0__tar.gz

{crieur-1.0.4 → crieur-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crieur
-Version: 1.0.4
+Version: 1.1.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

{crieur-1.0.4 → crieur-1.1.0}/crieur/__init__.py

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

{crieur-1.0.4 → crieur-1.1.0}/crieur/cli.py

@@ -22,10 +22,12 @@ 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",
 ):
     """Generate a new revue website.
 
@@ -41,7 +43,9 @@ 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)

{crieur-1.0.4 → crieur-1.1.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")

{crieur-1.0.4 → crieur-1.1.0}/crieur/models.py

@@ -20,19 +20,21 @@ class Numero(YAMLWizard):
 
         loaded_articles = []
         for article in self.articles:
+            article_slug = slugify(article["article"]["title"])
             article_folder = (
-                yaml_path.parent
-                / f"{article['article']['title']}-{article['article']['_id']}"
+                yaml_path.parent / f"{article_slug}-{article['article']['_id']}"
             )
-            article_yaml_path = article_folder / f"{article['article']['title']}.yaml"
+            article_yaml_path = article_folder / f"{article_slug}.yaml"
             try:
                 loaded_article = Article.from_yaml_file(article_yaml_path)
             except ComposerError:
                 loaded_article = Article.from_yaml(
                     article_yaml_path.read_text().split("---")[1]
                 )
+            if not loaded_article.id:
+                loaded_article.id = article_slug
             loaded_article.content_md = (
-                article_folder / f"{article['article']['title']}.md"
+                article_folder / f"{article_slug}.md"
             ).read_text()
             loaded_article.images_path = (
                 article_folder / "images"
@@ -46,13 +48,13 @@ class Numero(YAMLWizard):
 
 @dataclass
 class Article(YAMLWizard):
-    id: str
     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

{crieur-1.0.4 → crieur-1.1.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.name }}/">{{ numero.name }}</a></h2>
 
   <article>
     <header>

{crieur-1.0.4 → crieur-1.1.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 -->