Merge pull request #20 from zarhus/zdm2_opening_and_closing

ZDM#2 opening and closing presentations

Author: pietrushnic

.markdownlint.yaml

@@ -5,8 +5,6 @@
 # Default state for all rules
 default: false
 
-MD001: false  # Heading increment
-
 # MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading
 MD002:
   # Heading level
@@ -17,9 +15,9 @@ MD002:
 MD003: false
 
 # MD004/ul-style - Unordered list style
-MD004:
-  # List style
-  style: "sublist"
+# MD004:
+#   # List style
+#   style: "sublist"
 
 # MD005/list-indent - Inconsistent indentation for list items at the same level
 MD005: true
@@ -30,7 +28,7 @@ MD006: true
 # MD007/ul-indent - Unordered list indentation
 MD007:
   # Spaces for indent
-  indent: 4
+  indent: 2
   # Whether to indent the first level of the list
   start_indented: false
 
@@ -58,24 +56,25 @@ MD012:
   # Consecutive blank lines
   maximum: 1
 # MD013/line-length - Line length
-#
-MD013:
-  # Number of characters
-  line_length: 80
-  # Number of characters for headings
-  heading_line_length: 80
-  # Number of characters for code blocks
-  code_block_line_length: 160
-  # Include code blocks
-  code_blocks: false
-  # Include tables
-  tables: false
-  # Include headings
-  headings: true
-  # Strict length checking (e.g. allow for longer URLs)
-  strict: false
-  # Stern length checking
-  stern: false
+# FIXME: disable this check right now, as there is some stuff to fix first.
+# Maybe it does not make that much sense for presentations?
+# MD013:
+#   # Number of characters
+#   line_length: 80
+#   # Number of characters for headings
+#   heading_line_length: 80
+#   # Number of characters for code blocks
+#   code_block_line_length: 160
+#   # Include code blocks
+#   code_blocks: false
+#   # Include tables
+#   tables: false
+#   # Include headings
+#   headings: true
+#   # Strict length checking (e.g. allow for longer URLs)
+#   strict: false
+#   # Stern length checking
+#   stern: false
 
 # MD014/commands-show-output - Dollar signs used before commands without showing output
 # TODO: set false for now but we should consider enabling it
@@ -94,9 +93,13 @@ MD022: false
 # MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line
 MD023: true
 
-MD025: false  # Allow multiple h1
+# MD025/single-title/single-h1 - Multiple top-level headings in the same document
+# TODO: consider enabling it
 
-MD026: false  # Trailing punctation in heading
+# MD026/no-trailing-punctuation - Trailing punctuation in heading
+MD026:
+  # Punctuation characters
+  punctuation: ".,;:!。，；：！"
 
 # MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol
 MD027: true
@@ -120,15 +123,12 @@ MD030:
   # Spaces for multi-line ordered list items
   ol_multi: 1
 
-# MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines
-MD031:
-  # Include list items
-  list_items: true
-
-MD033: false  # Allow inline HTML
+# MD033/no-inline-html - Inline HTML
+# slidev superpowers are in inline html, so it has to be allowed
+MD033: false
 
 # MD034/no-bare-urls - Bare URL used
-MD034: true
+MD034: false
 
 # MD035/hr-style - Horizontal rule style
 MD035:
@@ -142,19 +142,14 @@ MD037: true
 MD038: true
 
 # MD039/no-space-in-links - Spaces inside link text
-MD039: false
+MD039: true
 
 # MD040/fenced-code-language - Fenced code blocks should have a language specified
 MD040: true
 
-# MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading
-MD041: false
-
 # MD042/no-empty-links - No empty links
 MD042: true
 
-MD045: false  # Allow no alt text
-
 # MD046/code-block-style - Code block style
 MD046:
   # Block style

.pre-commit-config.yaml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 3mdeb <[email protected]>
+#
+# SPDX-License-Identifier: Apache-2.0
+
 ---
 default_stages: [pre-commit]
 
@@ -8,15 +12,14 @@ exclude: ^hooks/test/
 ci:
   autoupdate_commit_msg: 'pre-commit: autoupdate hooks'
   autofix_prs: false
-  # shellcheck requires docker, which is not available on pre-commit.ci
+  # docker is not supported on pre-commit.ci
   skip: [shellcheck]
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
       - id: check-added-large-files
-        args: ['--maxkb=1024']
       - id: check-merge-conflict
       - id: check-symlinks
       - id: detect-private-key
@@ -35,6 +38,7 @@ repos:
     rev: v2.4.1
     hooks:
       - id: codespell
+        args: ['--config', '.codespellrc']
         exclude: >
             (?x)^(
                 .*\.svg|
@@ -62,4 +66,4 @@ repos:
   - repo: https://github.com/psf/black
     rev: 25.1.0
     hooks:
-    - id: black
+      - id: black

diagrams/dts_releases.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python3
+
+# SPDX-FileCopyrightText: 2024 3mdeb <[email protected]>
+#
+# SPDX-License-Identifier: Apache-2.0
+import matplotlib.pyplot as plt
+
+dts = {}
+
+# Dasharo Tools Suite
+dts["v1.2.8"] = 23  # wic+iso
+dts["v1.2.13"] = 50
+dts["v1.2.14"] = 49
+dts["v1.2.15"] = 23
+dts["v1.2.16"] = 37
+dts["v1.2.17"] = 37
+dts["v1.2.18"] = 158
+dts["v1.2.19"] = 132
+dts["v1.2.20"] = 46  # only wic
+dts["v1.2.21"] = 200
+dts["v1.2.22"] = 8
+dts["v1.2.23"] = 131
+dts["v2.0.0"] = 221
+dts["v2.1.0"] = 31
+dts["v2.1.1"] = 51
+dts["v2.1.2"] = 21
+dts["v2.1.3"] = 606
+dts["v2.2.0"] = 51
+dts["v2.2.1"] = 87
+dts["v2.3.0"] = 24
+dts["v2.4.0"] = 106
+dts["v2.5.0"] = 100
+
+releases = list(dts.keys())
+dts_values = list(dts.values())
+
+plt.figure(figsize=(12, 7))
+
+bars_dts = plt.bar(
+    releases,
+    dts_values,
+    color="#38d430",
+    label="Dasharo Tools Suite Releases",
+)
+
+plt.xticks(rotation=30, ha="right")
+
+plt.title(
+    "Number of DTS Public Releases Downloads per version",
+    fontsize=18,
+    fontweight="bold",
+    color="#272727",
+)
+plt.xlabel("Version", fontsize=16, fontweight="bold", color="#272727")
+plt.ylabel("Number of Downloads", fontsize=16, fontweight="bold", color="#272727")
+
+# Add sum on top of stacked bars
+for i in range(len(releases)):
+    if dts_values[i] != 0:
+        total = dts_values[i]
+        plt.annotate(
+            f"{total}",
+            xy=(
+                bars_dts[i].get_x() + bars_dts[i].get_width() / 2,
+                bars_dts[i].get_y() + bars_dts[i].get_height(),
+            ),
+            xytext=(0, 3),  # 3 points vertical offset
+            textcoords="offset points",
+            ha="center",
+            va="bottom",
+            color="black",
+            fontsize=14,
+            fontweight="bold",
+        )
+
+plt.legend(fontsize=12)
+
+plt.gca().set_facecolor("#f5f5f5")
+
+plt.savefig("img/zdm_2/dts_release_downloads.png", dpi=300)
+
+plt.close()

diagrams/gh_rel.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+import argparse
+import os
+import sys
+
+import requests
+
+
+def fetch_releases(repo, token=None):
+    """Yield release dictionaries from the GitHub API, handling pagination."""
+    url = f"https://api.github.com/repos/{repo}/releases"
+    headers = {"Accept": "application/vnd.github+json"}
+    if token:
+        headers["Authorization"] = f"token {token}"
+    page = 1
+    while True:
+        resp = requests.get(
+            url, headers=headers, params={"per_page": 100, "page": page}, timeout=30
+        )
+        resp.raise_for_status()
+        data = resp.json()
+        if not data:
+            break
+        for release in data:
+            yield release
+        page += 1
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(
+        description="Print download counts for every release in a GitHub repository"
+    )
+    parser.add_argument("repo", help="repository in the form owner/name")
+    parser.add_argument(
+        "--token", help="GitHub personal access token " "(or set GITHUB_TOKEN)"
+    )
+    parser.add_argument(
+        "--per-asset", action="store_true", help="show counts for each asset as well"
+    )
+    args = parser.parse_args()
+
+    token = args.token or os.getenv("GITHUB_TOKEN")
+    try:
+        for rel in fetch_releases(args.repo, token):
+            tag = rel.get("tag_name") or rel.get("name") or "<no-tag>"
+            assets = rel.get("assets", [])
+            total = sum(asset.get("download_count", 0) for asset in assets)
+            print(f"{tag}: {total} downloads")
+            if args.per_asset:
+                for asset in assets:
+                    name = asset.get("name", "<unnamed>")
+                    count = asset.get("download_count", 0)
+                    print(f"  {name}: {count}")
+    except requests.HTTPError as e:
+        sys.exit(f"GitHub API error: {e.response.status_code} {e.response.reason}")
+    except requests.RequestException as e:
+        sys.exit(f"Network error: {e}")
+
+
+if __name__ == "__main__":
+    main()

diagrams/rte_releases.py

@@ -0,0 +1,65 @@
+#!/usr/bin/env python3
+
+# SPDX-FileCopyrightText: 2024 3mdeb <[email protected]>
+#
+# SPDX-License-Identifier: Apache-2.0
+import matplotlib.pyplot as plt
+
+rte = {}
+
+# RTE OS
+rte["v0.7.1"] = 19
+rte["v0.7.3"] = 35
+rte["v0.7.4"] = 11
+rte["v0.7.5"] = 33
+rte["v0.8.0-rc1"] = 10
+
+releases = list(rte.keys())
+rte_values = list(rte.values())
+
+plt.figure(figsize=(12, 7))
+
+bars_rte = plt.bar(
+    releases,
+    rte_values,
+    color="#38d430",
+    label="RTE OS Releases",
+)
+
+plt.xticks(rotation=30, ha="right")
+
+plt.title(
+    "Number of rte Public Releases Downloads per version",
+    fontsize=18,
+    fontweight="bold",
+    color="#272727",
+)
+plt.xlabel("Version", fontsize=16, fontweight="bold", color="#272727")
+plt.ylabel("Number of Downloads", fontsize=16, fontweight="bold", color="#272727")
+
+# Add sum on top of stacked bars
+for i in range(len(releases)):
+    if rte_values[i] != 0:
+        total = rte_values[i]
+        plt.annotate(
+            f"{total}",
+            xy=(
+                bars_rte[i].get_x() + bars_rte[i].get_width() / 2,
+                bars_rte[i].get_y() + bars_rte[i].get_height(),
+            ),
+            xytext=(0, 3),  # 3 points vertical offset
+            textcoords="offset points",
+            ha="center",
+            va="bottom",
+            color="black",
+            fontsize=14,
+            fontweight="bold",
+        )
+
+plt.legend(fontsize=12)
+
+plt.gca().set_facecolor("#f5f5f5")
+
+plt.savefig("img/zdm_2/rte_release_downloads.png", dpi=300)
+
+plt.close()