pressoir 3.0.0__py3-none-any.whl

pressoir/__init__.py

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

pressoir/__main__.py

@@ -0,0 +1,3 @@
+from .cli import main
+
+main()

pressoir/additionals.py

@@ -0,0 +1,119 @@
+#!/usr/bin/env python3
+import html
+import tempfile
+from collections import namedtuple
+
+import pypandoc
+import yaml
+from progressist import ProgressBar
+
+from .utils import get_template_path, strip_html_comments
+
+AdditionalContent = namedtuple("AdditionalContent", "id, title, type, yaml, md, html")
+SEPARATOR = "## "
+
+
+def extract_additional_data(repository_path, chapter):
+    additional_path = repository_path / "textes" / chapter.id / "additionnels.md"
+    if not additional_path.exists():
+        return False
+    additional_data = additional_path.read_text()
+    if not additional_data.strip() or SEPARATOR not in additional_data:
+        return False
+    return additional_data
+
+
+def extract_additional_content(repository_path, chapter, additional_item):
+    try:
+        additional_id, yaml_content, md_content = additional_item.split("---", 2)
+    except ValueError as error:
+        print(f"    /!\\ Error in {chapter.id}/additionels.md (malformed file)")
+        print(additional_item)
+        print(error)
+        return False
+
+    additional_id = additional_id.strip()
+    if additional_id.startswith(SEPARATOR):
+        additional_id = strip_html_comments(additional_id[len(SEPARATOR) :]).strip()
+
+    try:
+        yaml_content_loaded = yaml.load(yaml_content, Loader=yaml.Loader)
+    except yaml.scanner.ScannerError as error:
+        print(f"    /!\\ Error in {chapter.id}/additionels.md (malformed file)")
+        print(error)
+        return False
+
+    additional_title = yaml_content_loaded.get("title")
+    additional_type = yaml_content_loaded.get("type")
+
+    if additional_type is None:
+        return False
+
+    if additional_type.startswith("texte"):
+        additional_type = "texte"
+    elif additional_type in ["entretien", "situation", "tableau"]:
+        additional_type = "article"
+    template_path = get_template_path(repository_path, f"{additional_type}.html")
+    with tempfile.NamedTemporaryFile() as metadata_file:
+        yaml_content += "suppress-bibliography: true\n"
+        metadata_file.write(yaml_content.encode("utf-8"))
+        metadata_file.read()  # Required to be readable by Pandoc.
+        bib_file = repository_path / "textes" / chapter.id / f"{chapter.id}.bib"
+        html_content = pypandoc.convert_text(
+            md_content,
+            "html",
+            format="md",
+            extra_args=[
+                "--ascii",
+                "--citeproc",
+                f"--bibliography={bib_file}",
+                f"--template={template_path}",
+                f"--metadata-file={metadata_file.name}",
+                f"--variable=additional_id:{additional_id}",
+            ],
+        )
+    return AdditionalContent(
+        **{
+            "id": additional_id,
+            "title": additional_title,
+            "type": additional_type,
+            "yaml": yaml_content,
+            "md": md_content,
+            "html": html_content,
+        }
+    )
+
+
+def extract_additional_contents(repository_path, chapter):
+    additional_contents = []
+    additional_data = extract_additional_data(repository_path, chapter)
+    if not additional_data:
+        return []
+    additional_parts = additional_data.split(f"\n{SEPARATOR}")
+    bar = ProgressBar(
+        total=len(additional_parts), prefix="    Loading additional contents:"
+    )
+    for additional_item in bar.iter(additional_parts):
+        if not additional_item:
+            continue
+        additional_content = extract_additional_content(
+            repository_path, chapter, additional_item
+        )
+        if not additional_content:
+            continue
+        additional_contents.append(additional_content)
+    return additional_contents
+
+
+def include_additional_contents(repository_path, chapter, html_content):
+    # Useful to be able to match the `contenuadd_pattern`, otherwise
+    # escaped special chars will not match:
+    # "EnvironnementNumérique" vs. "EnvironnementNumérique".
+    html_content = html.unescape(html_content)
+    for additional_content in extract_additional_contents(repository_path, chapter):
+        contenuadd_pattern = f"!contenuadd(./{additional_content.id})"
+        html_content = html_content.replace(
+            f"<p>{contenuadd_pattern}</p>",
+            f"<!-- From: {contenuadd_pattern} -->\n{additional_content.html}",
+        )
+    return html_content

pressoir/cli.py

@@ -0,0 +1,133 @@
+import contextlib
+import os
+import shutil
+import socket
+from http.server import SimpleHTTPRequestHandler, ThreadingHTTPServer, test
+from pathlib import Path
+from typing import Optional
+
+from minicli import cli, run
+
+from . import ROOT_DIR, VERSION
+from .generator import generate_chapters, generate_homepage
+from .indexes import generate_indexes
+from .models import configure_book
+from .statics import bundle_statics, sync_statics
+
+
+@cli
+def version():
+    """Return the current version of pressoir."""
+    print(f"Pressoir version: {VERSION}")
+
+
+@cli
+@cli("collection", choices=["pum", "sp", "blank"])
+def init(repository_path: Path = Path(), collection: str = "blank"):
+    """Initialize a new book to `repository_path` or current directory.
+
+    :repository_path: Absolute or relative path to book’s sources (default: current).
+    :collection: Name of the collection (default: blank).
+    """
+    print(
+        f"Initializing a new book: `{repository_path}` for `{collection}` collection."
+    )
+
+    if not (repository_path / "presssoir").exists():
+        shutil.copytree(
+            ROOT_DIR / "init" / collection / "pressoir",
+            repository_path / "pressoir",
+            dirs_exist_ok=True,
+        )
+
+    if "textes" not in os.listdir(repository_path):
+        shutil.copytree(
+            ROOT_DIR / "init" / collection / "textes",
+            repository_path / "textes",
+            dirs_exist_ok=True,
+        )
+
+    if "doc" not in os.listdir(repository_path) and "doc" in os.listdir(
+        ROOT_DIR / "init" / collection
+    ):
+        shutil.copytree(
+            ROOT_DIR / "init" / collection / "doc",
+            repository_path / "doc",
+            dirs_exist_ok=True,
+        )
+
+
+@cli
+def docs(target_path: Optional[Path] = None):
+    """Generate documentation with pressoir itself. #SoMeta"""
+    if target_path is None:
+        target_path = Path(os.getenv("PWD")) / "public"
+    else:
+        target_path = Path(target_path)
+    print(f"Generating documentation in `{target_path.resolve()}`.")
+    build(ROOT_DIR / "docs", target_path)
+
+
+@cli
+def build(
+    repository_path: Path = Path(),
+    target_path: Optional[Path] = None,
+    chapter: str = "",
+    verbose: bool = False,
+):
+    """Build a book from `repository_path` or current directory.
+
+    :repository_path: Absolute or relative path to book’s sources (default: current).
+    :target_path: Where the book will be built (default: `repository_path`/public).
+    :chapter: Specify a given chapter id (e.g. `chapter1`).
+    :verbose: Display more informations during the build.
+    """
+    if target_path is None:
+        target_path = repository_path / "public"
+    target_path.mkdir(parents=True, exist_ok=True)
+    print(
+        f"Building a book from {repository_path.resolve()} to {target_path.resolve()}."
+    )
+    sync_statics(repository_path, target_path)
+    css_filename, js_filename = bundle_statics(repository_path, target_path)
+    book = configure_book(repository_path / "textes" / "garde" / "livre.yaml")
+    if verbose:
+        import pprint
+
+        pprint.pprint(book)
+
+    meta = {"css_filename": css_filename, "js_filename": js_filename}
+    generate_homepage(repository_path, target_path, book, meta)
+    generate_chapters(repository_path, target_path, book, meta, chapter)
+    generate_indexes(repository_path, target_path, book)
+
+
+@cli
+def serve(repository_path: Path = Path(), port: int = 8000):
+    """Serve an HTML book from `repository_path`/public or current directory/public.
+
+    :repository_path: Absolute or relative path to book’s sources (default: current).
+    :port: Port to serve the book from (default=8000)
+    """
+    print(
+        f"Serving HTML book from `{repository_path}/public` to http://127.0.0.1:{port}"
+    )
+
+    # From https://github.com/python/cpython/blob/main/Lib/http/server.py#L1307-L1326
+    class DirectoryServer(ThreadingHTTPServer):
+        def server_bind(self):
+            # suppress exception when protocol is IPv4
+            with contextlib.suppress(Exception):
+                self.socket.setsockopt(socket.IPPROTO_IPV6, socket.IPV6_V6ONLY, 0)
+            return super().server_bind()
+
+        def finish_request(self, request, client_address):
+            self.RequestHandlerClass(
+                request, client_address, self, directory=str(repository_path / "public")
+            )
+
+    test(HandlerClass=SimpleHTTPRequestHandler, ServerClass=DirectoryServer, port=port)
+
+
+def main():
+    run()

pressoir/docs/pressoir/book.toml

@@ -0,0 +1,17 @@
+[statics]
+css_files = [
+  "static/css/fonts.css",
+  "static/css/vars.css",
+  "static/css/custom.css",
+]
+
+[indexes]
+ids = [
+  "personnalite",
+]
+names = [
+  "Personnalités",
+]
+images = [
+  "./svg/personnalite.svg",
+]

pressoir/docs/pressoir/static/css/custom.css

@@ -0,0 +1,294 @@
+/* The place to define a new theme/identity. */
+h1, h2, h3, h4, h5, h6 {
+    font-family: var(--font-family-headers);
+}
+
+header.main a.logo {
+  width: 322px;
+}
+
+header.main {
+    border-bottom-width: 2px;
+}
+
+header.main h1 {
+    font-variant: small-caps;
+}
+
+header.main h2 a {
+    border-color: var(--body-color);
+}
+
+h1.title {
+    margin-top: 7rem;
+    font-size: 4rem;
+    max-width: 60rem;
+    line-height: 1.15;
+    margin-bottom: 3rem;
+    color: black;
+    font-variant: small-caps;
+}
+h1.title::after {
+    display: block;
+    content: " ";
+    height: 2px;
+    width: 50%;
+    background: red;
+    margin-top: 2rem;
+    margin-left: 3rem;
+}
+
+blockquote::after,
+.introchapitre::after,
+.sidenote::after,
+.marginnote::after {
+    display: block;
+    content: " ";
+    height: 2px;
+    width: 35%;
+    background: red;
+    margin-top: 1rem;
+    margin-bottom: 2rem;
+    margin-left: 8rem;
+}
+
+blockquote {
+    background: no-repeat top left/3rem url("./svg/quote.svg");
+    padding-top: 1rem;
+    padding-left: 3.5rem;
+    margin: 4rem 0 4rem -1.5rem;
+}
+blockquote::after,
+.introchapitre::after {
+    width: 13%;
+    margin-left: 30rem;
+}
+
+blockquote p {
+    margin-top: 0;
+    width: 54%;
+}
+
+@media (max-width: 760px) {
+    blockquote::after,
+    .introchapitre::after {
+        width: 13%;
+        margin-left: 10rem;
+    }
+
+    blockquote p,
+    blockquote ul,
+    blockquote ol {
+        width: 80%;
+        font-size: medium;
+        line-height: 1.5;
+    }
+}
+
+img {
+    border-bottom: 2px solid red;
+}
+blockquote img {
+    border-bottom: none;
+    margin: 2rem;
+}
+
+.introchapitre,
+.concluchapitre {
+    font-family: 'Averia Libre';
+    width: 55%;
+}
+.introchapitre {
+    margin-bottom: 5rem;
+}
+
+.introchapitre p::first-letter,
+.concluchapitre p::first-letter {
+  font-size: 5rem;
+  padding-left: .5rem;
+  padding-right: .5rem;
+  float: left;
+  color: red;
+}
+
+.epigraphe {
+    width: 50%;
+    text-align: right;
+    margin: 1rem 0 5rem 7rem;
+}
+.epigraphe p {
+    margin-right: 2rem;
+    font-size: 1.1rem;
+    color: black;
+}
+.epigraphe p .citation {
+    display: block;
+}
+
+.contenuadd,
+.contenuadd a,
+.contenuadd p.source {
+    color: var(--body-color);
+}
+.contenuadd.lowpriority.expanded .source a.button,
+.contenuadd.highpriority .source a.button {
+    background-color: var(--body-color);
+}
+
+footer {
+    border-top: 2px solid #b3b3b3;
+    background: white;
+    width: 100%;
+}
+
+footer nav ul {
+    font-variant: small-caps;
+}
+
+footer nav ul li:not(:first-child):not(:last-child) {
+    border-left: none;
+    border-right: none;
+}
+footer nav ul li:not(:first-child):not(:last-child)::before {
+    display: inline-block;
+    content: " ";
+    height: 40%;
+    width: 2px;
+    background: var(--footer-border-color);
+    margin-right: 1rem;
+}
+footer nav ul li:not(:first-child):not(:last-child)::after {
+    display: inline-block;
+    content: " ";
+    height: 40%;
+    width: 2px;
+    background: var(--footer-border-color);
+    margin-left: 1rem;
+}
+
+@media (max-width: 1025px) {
+    header.main a.logo {
+        background-image: url("./svg/pum-logo-couleur.svg");
+    }
+}
+
+table tbody tr.odd {
+    background: var(--contenuadd-background);
+}
+table tbody td {
+    padding: 0.2rem;
+    min-width: 65px;
+}
+
+.grand-tableau table {
+    font-size: 0.75em;
+}
+
+pre {
+    max-width: 55%;
+    padding: 1em;
+    background-color: lavenderblush;
+}
+
+pre > code {
+    font-size: 1rem;
+    white-space: pre-wrap;
+}
+
+article ul {
+    max-width: none;
+}
+
+    code {
+      font-family: Menlo, Monaco, 'Lucida Console', Consolas, monospace;
+      font-size: 85%;
+      margin: 0;
+    }
+    pre {
+      margin: 1em 0;
+      overflow: auto;
+    }
+    pre code {
+      padding: 0;
+      overflow: visible;
+      overflow-wrap: normal;
+    }
+    .sourceCode {
+     width:55%;
+     background-color: transparent;
+     overflow: visible;
+    }
+    .sourceCode .sourceCode,
+    li .sourceCode {
+        width: 98%;
+    }
+code{white-space: pre-wrap;}
+    span.smallcaps{font-variant: small-caps;}
+    span.underline{text-decoration: underline;}
+    div.column{display: inline-block; vertical-align: top; width: 50%;}
+    div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
+    ul.task-list{list-style: none;}
+    pre > code.sourceCode { white-space: pre; position: relative; }
+    pre > code.sourceCode > span { display: inline-block; line-height: 1.25; width: 98%; }
+    pre > code.sourceCode > span.highlight { background: #00ffcf3b; }
+    pre > code.sourceCode > span:empty { height: 1.2em; }
+    .sourceCode { overflow: visible; }
+    code.sourceCode > span { color: inherit; text-decoration: inherit; }
+    div.sourceCode { margin: 1em 0; }
+    pre.sourceCode { margin: 0; }
+    @media screen {
+    div.sourceCode { overflow: auto; }
+    }
+    @media print {
+    pre > code.sourceCode { white-space: pre-wrap; }
+    pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
+    }
+    pre.numberSource code
+      { counter-reset: source-line 0; }
+    pre.numberSource code > span
+      { position: relative; left: -4em; counter-increment: source-line; }
+    pre.numberSource code > span > a:first-child::before
+      { content: counter(source-line);
+        position: relative; left: -1em; text-align: right; vertical-align: baseline;
+        border: none; display: inline-block;
+        -webkit-touch-callout: none; -webkit-user-select: none;
+        -khtml-user-select: none; -moz-user-select: none;
+        -ms-user-select: none; user-select: none;
+        padding: 0 4px; width: 4em;
+        color: #aaaaaa;
+      }
+    pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa;  padding-left: 4px; }
+    div.sourceCode
+      {  background-color: #f8f8f8; }
+    @media screen {
+    pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
+    }
+    code span.al { color: #ef2929; } /* Alert */
+    code span.an { color: #8f5902; font-weight: bold; font-style: italic; } /* Annotation */
+    code span.at { color: #c4a000; } /* Attribute */
+    code span.bn { color: #0000cf; } /* BaseN */
+    code span.cf { color: #204a87; font-weight: bold; } /* ControlFlow */
+    code span.ch { color: #4e9a06; } /* Char */
+    code span.cn { color: #000000; } /* Constant */
+    code span.co { color: #8f5902; font-style: italic; } /* Comment */
+    code span.cv { color: #8f5902; font-weight: bold; font-style: italic; } /* CommentVar */
+    code span.do { color: #8f5902; font-weight: bold; font-style: italic; } /* Documentation */
+    code span.dt { color: #204a87; } /* DataType */
+    code span.dv { color: #0000cf; } /* DecVal */
+    code span.er { color: #a40000; font-weight: bold; } /* Error */
+    code span.ex { } /* Extension */
+    code span.fl { color: #0000cf; } /* Float */
+    code span.fu { color: #204a87; } /* Function */
+    code span.im { } /* Import */
+    code span.in { color: #8f5902; font-weight: bold; font-style: italic; } /* Information */
+    code span.kw { color: #204a87; font-weight: bold; } /* Keyword */
+    code span.op { color: #ce5c00; font-weight: bold; } /* Operator */
+    code span.ot { color: #8f5902; } /* Other */
+    code span.pp { color: #8f5902; font-style: italic; } /* Preprocessor */
+    code span.sc { color: #000000; } /* SpecialChar */
+    code span.ss { color: #4e9a06; } /* SpecialString */
+    code span.st { color: #4e9a06; } /* String */
+    code span.va { color: #000000; } /* Variable */
+    code span.vs { color: #4e9a06; } /* VerbatimString */
+    code span.wa { color: #8f5902; font-weight: bold; font-style: italic; } /* Warning */
+    .display.math{display: block; text-align: center; margin: 0.5rem auto;}

pressoir/docs/pressoir/static/css/fonts.css

@@ -0,0 +1,16 @@
+@font-face {
+    font-family: 'Averia Serif Libre';
+    src: url('./fonts/averiaseriflibre-light.woff2') format('woff2'),
+         url('./fonts/averiaseriflibre-light.woff') format('woff');
+    font-weight: normal;
+    font-style: normal;
+    font-display: swap;
+}
+@font-face {
+    font-family: 'Averia Libre';
+    src: url('./fonts/averialibre-bold.woff2') format('woff2'),
+         url('./fonts/averialibre-bold.woff') format('woff');
+    font-weight: bold;
+    font-style: normal;
+    font-display: swap;
+}

pressoir/docs/pressoir/static/css/vars.css

@@ -0,0 +1,33 @@
+/* Beware: Safari does not handle well relative paths in CSS vars.
+   See https://bugs.webkit.org/show_bug.cgi?id=190807 for reference. */
+:root {
+    --font-family: 'Averia Serif Libre';
+    --font-family-headers: 'Averia Libre';
+    --body-background: #fff;
+    --body-color: #432c2c;
+
+    --logo-position: no-repeat left center/100%;
+    --logo-url: url("./img/pressoir-logo.png");
+    --small-logo-url: url("./svg/pum-logo-couleur.svg");
+
+    --balloon-color: #686868;
+    --balloon-color-font: #e9ecef;
+    --balloon-font-size: .9rem;
+
+    --termeenrichi-background-image: url("./svg/plus.svg");
+    --termeenrichi-background-image-expanded: url("./svg/minus.svg");
+
+    --header-background-color: #eaeaea;
+    --header-border-color: #f00;
+    --header-color: #000;
+    --header-dropdown-background: 99% center no-repeat url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' width='35' height='35' viewBox='0 0 24 24' fill='none' stroke='currentColor' stroke-width='1.5' stroke-linecap='round' stroke-linejoin='round'><path d='M6 9l6 6 6-6'/></svg>");
+
+    --toc-border-color: #b3b3b3;
+    --toc-border-active-color: #000;
+
+    --contenuadd-border-color: #b3b3b3;
+    --contenuadd-background: #eaeaea;
+
+    --footer-background-color: #eaeaea;
+    --footer-border-color: #f00;
+}

pressoir/docs/pressoir/static/svg/minus.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M3 3h18v18H3zM8 12h8"/></svg>

pressoir/docs/pressoir/static/svg/personnalite.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="40" height="40" viewBox="0 0 24 24" fill="none" stroke="#e9ecef" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M20 21v-2a4 4 0 0 0-4-4H8a4 4 0 0 0-4 4v2"></path><circle cx="12" cy="7" r="4"></circle></svg>

pressoir/docs/pressoir/static/svg/plus.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M3 3h18v18H3zM12 8v8m-4-4h8"/></svg>