crieur 1.1.0__tar.gz → 1.3.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crieur
-Version: 1.1.0
+Version: 1.3.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.1.0 → crieur-1.3.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.1.0 → crieur-1.3.0}/crieur/__init__.py

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

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

@@ -10,7 +10,7 @@ from minicli import cli, run
 
 from . import VERSION
 from .generator import generate_html
-from .models import collect_keywords, configure_numero
+from .models import collect_authors, collect_keywords, configure_numero
 from .utils import each_file_from, each_folder_from
 
 
@@ -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):
@@ -43,12 +47,21 @@ def generate(
             numeros.append(numero)
 
     keywords = collect_keywords(numeros)
+    authors = collect_authors(numeros)
     generate_html(
-        title, base_url, numeros, keywords, extra_vars, target_path, templates_path
+        title,
+        base_url,
+        numeros,
+        keywords,
+        authors,
+        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.1.0 → crieur-1.3.0}/crieur/generator.py

@@ -23,7 +23,7 @@ def markdown(value):
 
 
 def generate_html(
-    title, base_url, numeros, keywords, extra_vars, target_path, templates_path
+    title, base_url, numeros, keywords, authors, extra_vars, target_path, templates_path
 ):
     environment = Env(loader=FileSystemLoader(str(templates_path)))
     environment.filters["slugify"] = slugify_
@@ -36,6 +36,7 @@ def generate_html(
         "base_url": base_url,
         "numeros": numeros,
         "keywords": keywords,
+        "authors": authors,
         "crieur_version": VERSION,
         **extra_vars,
     }
@@ -48,7 +49,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)
 
@@ -75,3 +76,10 @@ def generate_html(
         keyword_folder = target_path / "mot-clef" / keyword.slug
         keyword_folder.mkdir(parents=True, exist_ok=True)
         (keyword_folder / "index.html").write_text(content)
+
+    for slug, author in authors.items():
+        template_author = environment.get_template("author.html")
+        content = template_author.render(author=author, **common_params)
+        author_folder = target_path / "auteur" / author.slug
+        author_folder.mkdir(parents=True, exist_ok=True)
+        (author_folder / "index.html").write_text(content)

{crieur-1.1.0 → crieur-1.3.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)
@@ -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()
@@ -92,6 +98,29 @@ class Keyword:
         return len_self < len_other
 
 
+@dataclass
+class Author:
+    slug: str
+    forname: str
+    surname: str
+    articles: list
+
+    def __str__(self):
+        return f"{self.forname} {self.surname}"
+
+    def __eq__(self, other):
+        return self.slug == other.slug
+
+    def __lt__(self, other: "Author"):
+        if not isinstance(other, Author):
+            return NotImplemented
+        len_self = len(self.articles)
+        len_other = len(other.articles)
+        if len_self == len_other:
+            return self.slug > other.slug
+        return len_self < len_other
+
+
 def collect_keywords(numeros):
     keywords = {}
     for numero in numeros:
@@ -112,3 +141,29 @@ def collect_keywords(numeros):
                         article_keywords.append(kw)
             article.keywords = article_keywords
     return dict(sorted(keywords.items(), key=lambda item: item[1], reverse=True))
+
+
+def collect_authors(numeros):
+    authors = {}
+    for numero in numeros:
+        for article in numero.articles:
+            article_authors = []
+            for athr in article.authors:
+                author_forname = athr["forname"]
+                author_surname = athr["surname"]
+                author_name = f"{author_forname} {author_surname}"
+                author_slug = slugify(author_name)
+                if author_slug in authors:
+                    authors[author_slug].articles.append(article)
+                    kw = authors[author_slug]
+                else:
+                    kw = Author(
+                        slug=author_slug,
+                        forname=author_forname,
+                        surname=author_surname,
+                        articles=[article],
+                    )
+                    authors[author_slug] = kw
+                article_authors.append(kw)
+            article.authors = article_authors
+    return dict(sorted(authors.items(), key=lambda item: item[1], reverse=True))

{crieur-1.1.0 → crieur-1.3.0}/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>
@@ -14,6 +14,7 @@
             <details>
               <summary role="button"><em>{{ author.forname }} {{ author.surname }}</em></summary>
               {{ author.biography|markdown }}
+              <a href="{{ base_url }}auteur/{{ author.slug }}/" role="button" class="secondary">Autres articles de l’auteur·ice →</a>
             </details>
           {% endfor %}
         </div>

crieur-1.3.0/crieur/templates/author.html

@@ -0,0 +1,17 @@
+{% extends "base.html" %}
+
+{% block content %}
+  <article>
+    <header>
+      <h2>{{ author }} ({{ author.articles|length }})</h2>
+    </header>
+
+    <div>
+      <ul>
+        {% for article in author.articles %}
+          <li><a href="{{ base_url }}numero/{{ article.numero.slug }}/article/{{ article.id }}/">{{ article.title_f }}</a></li>
+        {% endfor %}
+      </ul>
+    </div>
+  </article>
+{% endblock content %}

{crieur-1.1.0 → crieur-1.3.0}/crieur/templates/base.html

@@ -21,6 +21,9 @@
     h1 {
         text-align: center;
     }
+    dt {
+        font-weight: bold;
+    }
   </style>
   {% block extra_head %}
   {% endblock extra_head %}

{crieur-1.1.0 → crieur-1.3.0}/crieur/templates/homepage.html

@@ -57,31 +57,47 @@
 {% endblock extra_head %}
 
 {% block content %}
-  {% for slug, keyword in keywords.items() %}
-    {% if loop.index < 20 %}
-      <a href="{{ base_url }}mot-clef/{{ keyword.slug }}/">#{{ keyword.name }}</a>({{ keyword.articles|length }}){%- if not loop.last -%}, {% endif %}
-    {% endif %}
-  {% endfor %}…
-  <details>
-    <summary role="button">Voir plus de mot-clés :</summary>
-    {% for slug, keyword in keywords.items() %}
-      {% if loop.index >= 20 %}
-        <a href="{{ base_url }}mot-clef/{{ keyword.slug }}/">#{{ keyword.name }}</a>({{ keyword.articles|length }}){%- if not loop.last -%}, {% endif %}
-      {% endif %}
-    {% endfor %}
-  </details>
+  <article>
+    <dl>
+      <dt>Mots-clefs :</dt>
+      <dd>
+        {% for slug, keyword in keywords.items() %}
+          {% if loop.index < 20 %}
+            <a href="{{ base_url }}mot-clef/{{ keyword.slug }}/">#{{ keyword.name }}</a>({{ keyword.articles|length }}){%- if not loop.last -%}, {% endif %}
+          {% endif %}
+        {% endfor %}{% if keywords|length >= 20 %}…
+          <details>
+            <summary role="button">Voir plus de mot-clés :</summary>
+            {% for slug, keyword in keywords.items() %}
+              {% if loop.index >= 20 %}
+                <a href="{{ base_url }}mot-clef/{{ keyword.slug }}/">#{{ keyword.name }}</a>({{ keyword.articles|length }}){%- if not loop.last -%}, {% endif %}
+              {% endif %}
+            {% endfor %}
+          </details>
+        {% endif %}
+      </dd>
+      <dt>Auteur·ices :</dt>
+      <dd>
+        {% for slug, author in authors.items() %}
+          {% if loop.index < 20 %}
+            <a href="{{ base_url }}auteur/{{ author.slug }}/">#{{ author }}</a>({{ author.articles|length }}){%- if not loop.last -%}, {% endif %}
+          {% endif %}
+        {% endfor %}
+      </dd>
+    </dl>
+  </article>
   <div class="grid">
   {% for numero in numeros %}
     <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.1.0 → crieur-1.3.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.1.0 → crieur-1.3.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 %}