crieur 1.1.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

crieur/__init__.py

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

crieur/cli.py

@@ -28,13 +28,17 @@ def generate(
     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):
@@ -47,8 +51,9 @@ def generate(
         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/generator.py

@@ -48,7 +48,7 @@ def generate_html(
     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/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)
@@ -59,6 +62,9 @@ class Article(YAMLWizard):
     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/templates/article.html

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

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/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/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 %}

{crieur-1.1.0.dist-info → crieur-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crieur
-Version: 1.1.0
+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.2.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+crieur/__init__.py,sha256=vS-uRjCVYd831WrrAwgUW3Tc3G_4y9BRca8t751Zuyg,77
+crieur/__main__.py,sha256=bYt9eEaoRQWdejEHFD8REx9jxVEdZptECFsV7F49Ink,30
+crieur/cli.py,sha256=UZSfoKYQFmrWxZjbLJcGAcXZ6nW_B3FCZxbno4OwQ6A,4862
+crieur/generator.py,sha256=8SZ3A1p3DFQoIg8qbKHF3sfvClI2_QhMAfBclNj0QTs,2651
+crieur/models.py,sha256=5HHA9_e4ijdLTOrx8oKEKG1W8nYq5hnp64qrd8s2hC8,3899
+crieur/utils.py,sha256=kIdxpd5LgVv13Lx2aEXzjQttBDtcppRlwNsH0vwX8f0,1566
+crieur/statics/pico.css,sha256=VdrimW9PLcEIzqJ__s062OrwBj_Jb6jZIwbtdqOtM-w,93407
+crieur/templates/article.html,sha256=BzTXmRxg3_SDSDzPIA_eOKGMa1o1wBAXzLvt3hWbv8w,1149
+crieur/templates/base.html,sha256=PQcEuobOFH-WVJKoiZ97UxSqhkgt-Ey7lO44Z778R_U,1480
+crieur/templates/homepage.html,sha256=NqKCwVcBesl43FKQWkKT4OV-vEnln_pWNVvi2nJD9fU,2458
+crieur/templates/keyword.html,sha256=Hv3Ep3R6oN5pBw14gfQT-aeqEiuFiatmVZLWn5hR1e4,428
+crieur/templates/numero.html,sha256=b9J6aW_h9ao7XlWA0Xc390ahOH5lHDI8A4iDq6tEZTo,1882
+crieur-1.2.0.dist-info/METADATA,sha256=f16Cd73x1hf00qi4pUGbfE0JqE8zpJ0-heyzPR6OYYM,44848
+crieur-1.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+crieur-1.2.0.dist-info/entry_points.txt,sha256=edmbmPxs9QXyvSMpPJBDPGw3vZOJEKqXJhysYNx3QSM,43
+crieur-1.2.0.dist-info/licenses/LICENSE,sha256=F5acw9_laHeyi4wPmQyf_ttyz81VqCIwScwO8C1FhXU,34519
+crieur-1.2.0.dist-info/RECORD,,

crieur-1.1.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-crieur/__init__.py,sha256=BMikC4L2BIrM8NdUYDW5AiBwdaigl96GdIqDk5a0N3A,77
-crieur/__main__.py,sha256=bYt9eEaoRQWdejEHFD8REx9jxVEdZptECFsV7F49Ink,30
-crieur/cli.py,sha256=XOtUYvRKKOOJdJQXlVqG9o7LfVxahofLbQacYnrumIA,4569
-crieur/generator.py,sha256=kOD3pql_esbjiI1YwT6ngrl-C4Dv8lju4HtY3XwK968,2651
-crieur/models.py,sha256=l6ZARcmCNBvc2jdZ8TIrbqO7yeqqJKfePzDFDlT4Cl4,3760
-crieur/utils.py,sha256=kIdxpd5LgVv13Lx2aEXzjQttBDtcppRlwNsH0vwX8f0,1566
-crieur/statics/pico.css,sha256=VdrimW9PLcEIzqJ__s062OrwBj_Jb6jZIwbtdqOtM-w,93407
-crieur/templates/article.html,sha256=KZuUxz1r2Wa1ehxD6zIt-jGeIt0QHX0lSTZCI4IzepQ,1149
-crieur/templates/base.html,sha256=PQcEuobOFH-WVJKoiZ97UxSqhkgt-Ey7lO44Z778R_U,1480
-crieur/templates/homepage.html,sha256=Z6ODT-FVLUT0BjpVNaIOqGp-8rrJYeKbJE37wsGapUU,2458
-crieur/templates/keyword.html,sha256=dNcq8fxRG9tDIoTJnKfzlaukyr25gHBRDXauAe2qlI8,428
-crieur/templates/numero.html,sha256=R_lBPiXMeSLGWCvy-4U4X1tJuNQHpK-dVVe3DaVtQ9o,1882
-crieur-1.1.0.dist-info/METADATA,sha256=5VPEMNQjYISxJbIXULWo0zNgXStotdic6SlAKgaYaQo,44515
-crieur-1.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-crieur-1.1.0.dist-info/entry_points.txt,sha256=edmbmPxs9QXyvSMpPJBDPGw3vZOJEKqXJhysYNx3QSM,43
-crieur-1.1.0.dist-info/licenses/LICENSE,sha256=F5acw9_laHeyi4wPmQyf_ttyz81VqCIwScwO8C1FhXU,34519
-crieur-1.1.0.dist-info/RECORD,,