finalized benchmark

Merge branch 'performance' into rebuild_needed_only
Merge branch 'master' into rebuild_needed_only
2025-11-25 12:42:41 +00:00 · 2025-01-22 15:17:28 +01:00 · 2025-01-22 14:46:42 +01:00 · 2025-01-22 14:46:29 +01:00 · 2025-01-22 14:46:14 +01:00 · 2025-01-22 14:14:46 +01:00
38 changed files with 428 additions and 157 deletions
--- a/.flake8
+++ b/.flake8
@@ -1,2 +0,0 @@
-[flake8]
-exclude = venv,build,docs
--- a/.github/dependabot.yml
+++ b/.github/dependabot.yml
@@ -4,6 +4,10 @@ updates:
    directory: "/"
    schedule:
      interval: "weekly"
+    groups:
+      all:
+        patterns:
+          - "*"

  - package-ecosystem: "github-actions"
    directory: "/"
--- a/.github/workflows/python-package.yaml
+++ b/.github/workflows/python-package.yaml
@@ -17,18 +17,14 @@ jobs:
          - macos-latest
          - windows-latest
        python-version:
-          - "3.8"
-          - "3.9"
          - "3.10"
          - "3.11"
-        exclude:
-          # 3.8 on windows fails due to some pip issue
-          - os: windows-latest
-            python-version: "3.8"
+          - "3.12"
+          - "3.13"

    steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v4
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}

@@ -41,8 +37,8 @@ jobs:
    runs-on: ubuntu-latest

    steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v4
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
      with:
        python-version: "3.x"

@@ -55,8 +51,8 @@ jobs:
    runs-on: ubuntu-latest

    steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v4
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
      with:
        python-version: "3.x"

@@ -70,8 +66,8 @@ jobs:
    runs-on: ubuntu-latest

    steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v4
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
      with:
        python-version: "3.x"

--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,58 @@
 # Changelog

+## [unreleased]
+
+* Added Python 3.13 to github actions
+
+## [2.3.2] -- 2024-10-13
+
+* Ignore FileNotFoundError when trying to get the last modified time of files
+  in directories. This happens for example with temporary emacs files.
+* Added changelog to docs
+* removed ruff's target-version from pyproject.toml, this value defaults to the
+  projects requires-python
+
+## [2.3.1] -- 2024-07-06
+
+* added manpage
+* added makefile target for generating blog's manpage
+* added makefile target for serving blags docs locally
+* mkdocs: disabled loading of google fonts, using locally installed system
+  fonts instead
+* Debian: simplified html docs directory for blag-doc package
+* Debian: changed section from Python to Web
+* updated dependencies
+
+## [2.3.0] -- 2024-04-24
+
+* fixed devsever so it does not crash anymore when the (re-)build fails
+* dropped support for Python 3.8 and 3.9
+* updated dependencies
+
+## [2.2.1] -- 2023-11-11
+
+* fixed `suggests` to blag-doc
+
+## [2.2.0] -- 2023-11-05
+
+* switched from flake8 to ruff
+* added missing docstrings
+* fixed dev requirements in pyproject, still pointing to sphinx
+* added Python3.12 to test suite
+* removed debian/watch
+
+## [2.1.0] -- 2023-08-27
+
+* default theme: `img` have now `max-width: 100%` by default to avoid very
+  large images overflowing
+* packaging: explicitly list `templates`, `static` and `content` as packages
+  instead of relying on package-data for setuptools. additionally, created a
+  MANIFEST.in to add the contents of these directories here as well. the
+  automatic finding of namespace packages and packaga-data, currently does not
+  work as advertised in setuptools' docs
+* updated dependencies
+* created debian/watch
+
 ## [2.0.0] - 2023-06-16

 ### Breaking
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -0,0 +1,3 @@
+recursive-include blag/content *
+recursive-include blag/static *
+recursive-include blag/templates *
--- a/14
+++ b/14
@@ -33,7 +33,7 @@ mypy: $(VENV)

 .PHONY: lint
 lint: $(VENV)
-	$(BIN)/flake8
+	$(BIN)/ruff check .

 .PHONY: build
 build: $(VENV)
@@ -57,6 +57,18 @@ update-pygmentize: $(VENV)
 docs: $(VENV)
 	$(BIN)/mkdocs build

+.PHONY: serve-docs
+serve-docs: $(VENV)
+	$(BIN)/mkdocs serve
+
+.PHONY: manpage
+manpage: $(VENV)
+	help2man $(BIN)/blag --no-info -n "blog-aware, static site generator" -o debian/blag.1
+
+.PHONY: benchmark
+benchmark: $(VENV)
+	$(BIN)/pytest --no-cov -capture=no -rA tests/benchmark.py
+
 .PHONY: clean
 clean:
 	rm -rf build dist *.egg-info
--- a/README.md
+++ b/README.md
@@ -16,14 +16,15 @@ blag is named after [the blag of the webcomic xkcd][blagxkcd].
 ## Features

 * Write content in [Markdown][]
-* Good looking default theme
+* Good looking default theme:
+  ![Blag Screenshot](blag/static/blag.png)
 * Theming support using [Jinja2][] templates
 * Generation of Atom feeds for blog content
 * Fenced code blocks and syntax highlighting using [Pygments][]
 * Integrated devserver
 * Available on [PyPI][]

-blag runs on Linux, Mac and Windows and requires Python >= 3.8
+blag runs on Linux, Mac and Windows and requires Python >= 3.10

 [markdown]: https://daringfireball.net/projects/markdown/
 [jinja2]: https://palletsprojects.com/p/jinja/
--- a/blag/blag.py
+++ b/blag/blag.py
@@ -1,11 +1,6 @@
 #!/usr/bin/env python3

-"""blag's core methods.
-
-"""
-
-# remove when we don't support py38 anymore
-from __future__ import annotations
+"""blag's core methods."""

 import argparse
 import configparser
@@ -32,7 +27,7 @@ logging.basicConfig(


 def main(arguments: list[str] | None = None) -> None:
-    """Main entrypoint for the CLI.
+    """Run the CLI.

    This method parses the CLI arguments and executes the respective
    commands.
@@ -328,7 +323,19 @@ def process_markdown(
    for src, dst in convertibles:
        logger.debug(f"Processing {src}")

-        with open(f"{input_dir}/{src}", "r") as fh:
+        # see first if the dst actually needs re-building. for that we compare
+        # the mtimes and assume mtime_dst > mtime_src means that it needs not
+        # to be rebuilt
+        if os.path.exists(f"{output_dir}/{dst}"):
+            mtime_src = os.stat(f"{input_dir}/{src}").st_mtime
+            mtime_dst = os.stat(f"{output_dir}/{dst}").st_mtime
+            if mtime_dst >= mtime_src:
+                logger.debug(
+                    "Skipping, as target exists and is newer than source."
+                )
+                continue
+
+        with open(f"{input_dir}/{src}") as fh:
            body = fh.read()

        content, meta = convert_markdown(md, body)
--- a/blag/content/second-post.md
+++ b/blag/content/second-post.md
@@ -7,3 +7,5 @@ Tags: blag
 ## Second Post

 This page serves no purpose :)
+
+![Blag Screenshot](blag.png)
--- a/blag/devserver.py
+++ b/blag/devserver.py
@@ -6,9 +6,6 @@ site if necessary.

 """

-# remove when we don't support py38 anymore
-from __future__ import annotations
-
 import argparse
 import logging
 import multiprocessing
@@ -45,14 +42,19 @@ def get_last_modified(dirs: list[str]) -> float:
    for dir in dirs:
        for root, dirs, files in os.walk(dir):
            for f in files:
-                mtime = os.stat(os.path.join(root, f)).st_mtime
+                try:
+                    mtime = os.stat(os.path.join(root, f)).st_mtime
+                except FileNotFoundError:
+                    # ignore files that have been deleted since the os.walk
+                    # call (for example temporary emacs files)
+                    continue
                if mtime > last_mtime:
                    last_mtime = mtime

    return last_mtime


-def autoreload(args: argparse.Namespace) -> NoReturn:
+def autoreload(args: argparse.Namespace, wait: int=1) -> NoReturn:
    """Start the autoreloader.

    This method monitors the given directories for changes (i.e. the
@@ -66,6 +68,9 @@ def autoreload(args: argparse.Namespace) -> NoReturn:
    ----------
    args
        contains the input-, template- and static dir
+    wait
+        number of seconds the devsever waits before checking for updated
+        content

    """
    dirs = [args.input_dir, args.template_dir, args.static_dir]
@@ -74,12 +79,18 @@ def autoreload(args: argparse.Namespace) -> NoReturn:
    # loop to avoid serving stale contents
    last_mtime = 0.0
    while True:
-        mtime = get_last_modified(dirs)
-        if mtime > last_mtime:
-            last_mtime = mtime
-            logger.info("Change detected, rebuilding...")
-            blag.build(args)
-        time.sleep(1)
+        # make sure the devsever does not crash when the build fails with an
+        # exception
+        try:
+            mtime = get_last_modified(dirs)
+            if mtime > last_mtime:
+                last_mtime = mtime
+                logger.info("Change detected, rebuilding...")
+                blag.build(args)
+            time.sleep(wait)
+        except Exception:
+            logger.exception("Error occurred during rebuild:")
+            logger.info("Devserver did not crash, you may continue editing.")


 def serve(args: argparse.Namespace) -> None:
--- a/blag/markdown.py
+++ b/blag/markdown.py
@@ -5,9 +5,6 @@ processing.

 """

-# remove when we don't support py38 anymore
-from __future__ import annotations
-
 import logging
 from datetime import datetime
 from urllib.parse import urlsplit, urlunsplit
@@ -94,9 +91,10 @@ def convert_markdown(


 class MarkdownLinkTreeprocessor(Treeprocessor):
-    """Converts relative links to .md files to .html"""
+    """Converts relative links to .md files to .html."""

    def run(self, root: Element) -> Element:
+        """Process the ElementTree."""
        for element in root.iter():
            if element.tag == "a":
                url = element.get("href")
@@ -109,6 +107,7 @@ class MarkdownLinkTreeprocessor(Treeprocessor):
        return root

    def convert(self, url: str) -> str:
+        """Convert relative .md-links to .html-links."""
        scheme, netloc, path, query, fragment = urlsplit(url)
        logger.debug(
            f"{url}: {scheme=} {netloc=} {path=} {query=} {fragment=}"
@@ -126,6 +125,7 @@ class MarkdownLinkExtension(Extension):
    """markdown.extension that converts relative .md- to .html-links."""

    def extendMarkdown(self, md: Markdown) -> None:
+        """Register the MarkdownLinkTreeprocessor."""
        md.treeprocessors.register(
            MarkdownLinkTreeprocessor(md),
            "mdlink",
--- a/blag/quickstart.py
+++ b/blag/quickstart.py
@@ -1,9 +1,4 @@
-"""Helper methods for blag's quickstart command.
-
-"""
-
-# remove when we don't support py38 anymore
-from __future__ import annotations
+"""Helper methods for blag's quickstart command."""

 import argparse
 import configparser
--- a/blag/static/blag.png
+++ b/blag/static/blag.png
--- a/blag/static/code-dark.css
+++ b/blag/static/code-dark.css
@@ -4,35 +4,36 @@ span.linenos { color: inherit; background-color: transparent; padding-left: 5px;
 td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 .hll { background-color: #49483e }
-.c { color: #75715e } /* Comment */
-.err { color: #960050; background-color: #1e0010 } /* Error */
+.c { color: #959077 } /* Comment */
+.err { color: #ed007e; background-color: #1e0010 } /* Error */
 .esc { color: #f8f8f2 } /* Escape */
 .g { color: #f8f8f2 } /* Generic */
 .k { color: #66d9ef } /* Keyword */
 .l { color: #ae81ff } /* Literal */
 .n { color: #f8f8f2 } /* Name */
-.o { color: #f92672 } /* Operator */
+.o { color: #ff4689 } /* Operator */
 .x { color: #f8f8f2 } /* Other */
 .p { color: #f8f8f2 } /* Punctuation */
-.ch { color: #75715e } /* Comment.Hashbang */
-.cm { color: #75715e } /* Comment.Multiline */
-.cp { color: #75715e } /* Comment.Preproc */
-.cpf { color: #75715e } /* Comment.PreprocFile */
-.c1 { color: #75715e } /* Comment.Single */
-.cs { color: #75715e } /* Comment.Special */
-.gd { color: #f92672 } /* Generic.Deleted */
+.ch { color: #959077 } /* Comment.Hashbang */
+.cm { color: #959077 } /* Comment.Multiline */
+.cp { color: #959077 } /* Comment.Preproc */
+.cpf { color: #959077 } /* Comment.PreprocFile */
+.c1 { color: #959077 } /* Comment.Single */
+.cs { color: #959077 } /* Comment.Special */
+.gd { color: #ff4689 } /* Generic.Deleted */
 .ge { color: #f8f8f2; font-style: italic } /* Generic.Emph */
+.ges { color: #f8f8f2; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .gr { color: #f8f8f2 } /* Generic.Error */
 .gh { color: #f8f8f2 } /* Generic.Heading */
 .gi { color: #a6e22e } /* Generic.Inserted */
 .go { color: #66d9ef } /* Generic.Output */
-.gp { color: #f92672; font-weight: bold } /* Generic.Prompt */
+.gp { color: #ff4689; font-weight: bold } /* Generic.Prompt */
 .gs { color: #f8f8f2; font-weight: bold } /* Generic.Strong */
-.gu { color: #75715e } /* Generic.Subheading */
+.gu { color: #959077 } /* Generic.Subheading */
 .gt { color: #f8f8f2 } /* Generic.Traceback */
 .kc { color: #66d9ef } /* Keyword.Constant */
 .kd { color: #66d9ef } /* Keyword.Declaration */
-.kn { color: #f92672 } /* Keyword.Namespace */
+.kn { color: #ff4689 } /* Keyword.Namespace */
 .kp { color: #66d9ef } /* Keyword.Pseudo */
 .kr { color: #66d9ef } /* Keyword.Reserved */
 .kt { color: #66d9ef } /* Keyword.Type */
@@ -51,9 +52,9 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .nn { color: #f8f8f2 } /* Name.Namespace */
 .nx { color: #a6e22e } /* Name.Other */
 .py { color: #f8f8f2 } /* Name.Property */
-.nt { color: #f92672 } /* Name.Tag */
+.nt { color: #ff4689 } /* Name.Tag */
 .nv { color: #f8f8f2 } /* Name.Variable */
-.ow { color: #f92672 } /* Operator.Word */
+.ow { color: #ff4689 } /* Operator.Word */
 .pm { color: #f8f8f2 } /* Punctuation.Marker */
 .w { color: #f8f8f2 } /* Text.Whitespace */
 .mb { color: #ae81ff } /* Literal.Number.Bin */
--- a/blag/static/code-light.css
+++ b/blag/static/code-light.css
@@ -16,6 +16,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
 .gd { color: #A00000 } /* Generic.Deleted */
 .ge { font-style: italic } /* Generic.Emph */
+.ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .gr { color: #E40000 } /* Generic.Error */
 .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .gi { color: #008400 } /* Generic.Inserted */
--- a/blag/static/style.css
+++ b/blag/static/style.css
@@ -1,33 +1,16 @@
@import "code-light.css" (prefers-color-scheme: light);
@import "code-dark.css" (prefers-color-scheme: dark);

-@media (prefers-color-scheme: light) {
-    :root {
-        --background: #FFFFFF;
-        --background-dim: #f5f7f9;
-
-        --foreground: #2B303A;
-        --foreground-dim: #576379;
-        --foreground-heavy: #191C22;
-
-        --primary-color: #375287;
-    }
+:root {
+    color-scheme: light dark;
+    --background: light-dark(#FFFFFF, #2B363B);
+    --background-dim: light-dark(#f5f7f9, #2F3C42);
+    --foreground: light-dark(#2B303A, #f0f2f3);
+    --foreground-dim: light-dark(#576379, #d5d5d5);
+    --foreground-heavy: light-dark(#191C22, #f2f4f5);
+    --primary-color: light-dark(#375287, #A1C5FF);
 }

-@media (prefers-color-scheme: dark) {
-    :root {
-        --background: #2B363B;
-        --background-dim: #2F3C42;
-
-        --foreground: #f0f2f3;
-        --foreground-dim: #d5d5d5;
-        --foreground-heavy: #f2f4f5;
-
-        --primary-color: #A1C5FF;
-    }
-}
-
-
 html {
  font-size: 18px;
  font-family: serif;
@@ -48,6 +31,10 @@ aside {
    color: var(--foreground-dim);
 }

+img {
+    max-width: 100%;
+}
+
 h1,
 h2,
 h3,
--- a/blag/version.py
+++ b/blag/version.py
@@ -1 +1,3 @@
-__VERSION__ = "2.0.0"
+"""Version information for the blag package."""
+
+__VERSION__ = "2.3.2"
--- a/debian/blag-doc.docs
+++ b/debian/blag-doc.docs
@@ -1 +1 @@
-site/
+site/*
--- a/debian/blag.1
+++ b/debian/blag.1
@@ -0,0 +1,28 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
+.TH BLAG "1" "July 2024" "blag 2.3.0" "User Commands"
+.SH NAME
+blag \- blog-aware, static site generator
+.SH DESCRIPTION
+usage: blag [\-h] [\-\-version] [\-v] {build,quickstart,serve} ...
+.SS "positional arguments:"
+.IP
+{build,quickstart,serve}
+.TP
+build
+Build website.
+.TP
+quickstart
+Quickstart blag, creating necessary configuration.
+.TP
+serve
+Start development server.
+.SS "options:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-\-version\fR
+show program's version number and exit
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Verbose output.
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,64 @@
+blag (2.3.2) unstable; urgency=medium
+
+  * Ignore FileNotFoundError when trying to get the last modified time of
+    files in directories. This happens for example with temporary emacs files.
+  * Added changelog to docs
+  * removed ruff's target-version from pyproject.toml, this value defaults to
+    the projects requires-python
+
+ -- Bastian Venthur <venthur@debian.org>  Sun, 13 Oct 2024 20:12:29 +0200
+
+blag (2.3.1) unstable; urgency=medium
+
+  * added manpage
+  * added makefile target for generating blog's manpage
+  * added makefile target for serving blags docs locally
+  * mkdocs: disabled loading of google fonts, using locally installed system
+    fonts instead
+  * Debian: simplified html docs directory for blag-doc package
+  * Debian: changed section in debian/control from Python to Web
+  * updated dependencies
+
+ -- Bastian Venthur <venthur@debian.org>  Sat, 06 Jul 2024 15:33:36 +0200
+
+blag (2.3.0) unstable; urgency=medium
+
+  * fixed devsever so it does not crash anymore when the (re-)build fails
+  * dropped support for Python 3.8 and 3.9
+  * updated dependencies
+
+ -- Bastian Venthur <venthur@debian.org>  Wed, 24 Apr 2024 22:25:31 +0200
+
+blag (2.2.1) unstable; urgency=medium
+
+  * fixed suggests field to blag-doc (Closes: #1055769)
+
+ -- Bastian Venthur <venthur@debian.org>  Sat, 11 Nov 2023 10:57:06 +0100
+
+blag (2.2.0) unstable; urgency=medium
+
+  * switched from flake8 to ruff
+  * added missing docstrings
+  * fixed dev requirements in pyproject, still pointing to sphinx
+  * added Python3.12 to test suite
+  * removed watch file again
+
+ -- Bastian Venthur <venthur@debian.org>  Sun, 05 Nov 2023 17:08:09 +0100
+
+blag (2.1.0) unstable; urgency=medium
+
+  * default theme: `img` have now `max-width: 100%` by default to avoid very
+    large images overflowing
+  * packaging: explicitly list `templates`, `static` and `content` as packages
+    instead of relying on package-data for setuptools. additionally, created a
+    MANIFEST.in to add the contents of these directories here as well. the
+    automatic finding of namespace packages and packaga-data, currently does
+    not work as advertised in setuptools' docs
+  * updated dependencies
+  * created debian/watch
+
+ -- Bastian Venthur <venthur@debian.org>  Sun, 27 Aug 2023 15:27:39 +0200
+
 blag (2.0.0) unstable; urgency=medium

  * new upstream version
--- a/debian/control
+++ b/debian/control
@@ -1,24 +1,24 @@
 Source: blag
-Section: python
+Section: web
 Priority: optional
 Maintainer: Bastian Venthur <venthur@debian.org>
 Rules-Requires-Root: no
 Build-Depends:
 debhelper-compat (= 13),
- dh-sequence-python3,
 dh-python,
- pybuild-plugin-pyproject,
- python3-setuptools,
- python3-all,
- python3-markdown,
- python3-feedgenerator,
- python3-jinja2,
- python3-pygments,
- python3-pytest,
- python3-pytest-cov,
+ dh-sequence-python3,
 mkdocs,
 mkdocs-material,
 mkdocstrings-python-handlers,
+ pybuild-plugin-pyproject,
+ python3-all,
+ python3-feedgenerator,
+ python3-jinja2,
+ python3-markdown,
+ python3-pygments,
+ python3-pytest,
+ python3-pytest-cov,
+ python3-setuptools,
 #Testsuite: autopkgtest-pkg-python
 Standards-Version: 4.6.0.1
 Homepage: https://github.com/venthur/blag
@@ -28,10 +28,10 @@ Vcs-Git: https://github.com/venthur/blag.git
 Package: blag
 Architecture: all
 Depends:
- ${python3:Depends},
 ${misc:Depends},
+ ${python3:Depends},
 Suggests:
- python-blag-doc,
+ blag-doc,
 Description: Blog-aware, static site generator
 Blag is a blog-aware, static site generator, written in Python. It supports
 the following features:
--- a/debian/manpages
+++ b/debian/manpages
@@ -0,0 +1 @@
+debian/blag.1
--- a/docs/CHANGELOG.md
+++ b/docs/CHANGELOG.md
@@ -0,0 +1 @@
+../CHANGELOG.md
--- a/docs/blag.png
+++ b/docs/blag.png
--- a/docs/index.md
+++ b/docs/index.md
@@ -16,14 +16,15 @@ blag is named after [the blag of the webcomic xkcd][blagxkcd].
 ## Features

 * Write content in [Markdown][]
-* Good looking default theme
+* Good looking default theme:
+  ![Blag Screenshot](blag.png)
 * Theming support using [Jinja2][] templates
 * Generation of Atom feeds for blog content
 * Fenced code blocks and syntax highlighting using [Pygments][]
 * Integrated devserver
 * Available on [PyPI][]

-blag runs on Linux, Mac and Windows and requires Python >= 3.8
+blag runs on Linux, Mac and Windows and requires Python >= 3.10

 [markdown]: https://daringfireball.net/projects/markdown/
 [jinja2]: https://palletsprojects.com/p/jinja/
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -13,10 +13,13 @@ nav:
    - blag.markdown: markdown.md
    - blag.devserver: devserver.md
    - blag.quickstart: quickstart.md
+  - Changelog: CHANGELOG.md

 theme:
  name: material
  highlightjs: true
+  # disable google fonts, use system fonts
+  font: false

 markdown_extensions:
  - pymdownx.superfences
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -11,7 +11,7 @@ description = "blog-aware, static site generator"
 keywords = ["markdown", "blag", "blog", "static site generator", "cli"]
 readme = "README.md"
 license = { file="LICENSE" }
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 dynamic = ["version"]
 dependencies = [
    "markdown",
@@ -31,12 +31,14 @@ blag = "blag.blag:main"
 [project.optional-dependencies]
 dev = [
    "build",
-    "sphinx",
+    "mkdocs",
+    "mkdocs-material",
+    "mkdocstrings[python]",
    "twine",
    "wheel",
    "pytest",
    "pytest-cov",
-    "flake8",
+    "ruff",
    "mypy",
    "types-markdown",
 ]
@@ -47,16 +49,12 @@ version = {attr = "blag.__VERSION__" }
 [tool.setuptools]
 packages = [
    "blag",
+    "blag.templates",
+    "blag.static",
+    "blag.content",
    "tests",
 ]

-[tool.setuptools.package-data]
-blag = [
-    "templates/*",
-    "static/*",
-    "content/*",
-]
-
 [tool.pytest.ini_options]
 addopts = """
    --cov=blag
@@ -65,6 +63,20 @@ addopts = """
    --cov-report=term-missing:skip-covered
 """

+[tool.ruff]
+line-length = 79
+
+[tool.ruff.lint]
+select = [
+    "F",        # pyflakes
+    "E", "W",   # pycodestyle
+    "C90",      # mccabe
+    "I",        # isort
+    "D",        # pydocstyle
+    "UP"        # pyupgrade
+]
+pydocstyle.convention = "numpy"
+
 [tool.mypy]
 files = "blag,tests"
 strict = true
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
@@ -1,11 +1,11 @@
-build==0.10.0
-mkdocs==1.4.3
-mkdocs-material==9.1.15
-mkdocstrings[python]==0.20.0
-twine==4.0.2
-wheel==0.40.0
-pytest==7.3.2
-pytest-cov==4.0.0
-flake8==6.0.0
-mypy==1.2.0
-types-markdown==3.4.2.9
+build==1.2.2.post1
+mkdocs==1.6.1
+mkdocs-material==9.5.49
+mkdocstrings[python]==0.27.0
+twine==6.0.1
+wheel==0.45.1
+pytest==8.3.4
+pytest-cov==6.0.0
+ruff==0.8.4
+mypy==1.14.0
+types-markdown==3.7.0.20241204
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,4 +1,4 @@
-markdown==3.4.3
-feedgenerator==2.0.0
-jinja2==3.1.2
-pygments==2.15.1
+markdown==3.7
+feedgenerator==2.1.0
+jinja2==3.1.5
+pygments==2.18.0
--- a/tests/init.py
+++ b/tests/init.py
@@ -0,0 +1 @@
+"""Tests for blag."""
--- a/tests/benchmark.py
+++ b/tests/benchmark.py
@@ -0,0 +1,37 @@
+"""Benchmark the performance of the blag build command."""
+
+import logging
+import os
+from argparse import Namespace
+
+from pytest import LogCaptureFixture
+
+import blag
+from blag.blag import build
+
+
+def test_performance(args: Namespace, caplog: LogCaptureFixture) -> None:
+    """Test performance of the build command."""
+    caplog.set_level(logging.ERROR)
+
+    FILES = 10000
+    print(f"Generating {FILES} markdown files")
+    # create random markdown files in the content directory
+    with open(os.path.join(blag.__path__[0], "content", "testpage.md")) as fh:
+        markdown = fh.read()
+    for i in range(FILES):
+        with open(f"content/{i}.md", "w") as f:
+            f.write(markdown)
+            f.write(str(i))
+
+    from time import time
+
+    t = time()
+    build(args)
+    t_first = time() - t
+
+    t = time()
+    build(args)
+    t_second = time() - t
+    print(f"First run: {t_first:.2f}s, second run: {t_second:.2f}s")
+    print(f"Speedup: {t_first/t_second:.2f}")
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -1,10 +1,9 @@
-# remove when we don't support py38 anymore
-from __future__ import annotations
+"""Pytest fixtures."""

 import os
 from argparse import Namespace
+from collections.abc import Callable, Iterator
 from tempfile import TemporaryDirectory
-from typing import Callable, Iterator

 import pytest
 from jinja2 import Environment, Template
@@ -14,6 +13,7 @@ from blag import blag, quickstart

@pytest.fixture
 def environment(cleandir: str) -> Iterator[Environment]:
+    """Create a Jinja2 environment."""
    site = {
        "base_url": "site base_url",
        "title": "site title",
@@ -26,31 +26,37 @@ def environment(cleandir: str) -> Iterator[Environment]:

@pytest.fixture
 def page_template(environment: Environment) -> Iterator[Template]:
+    """Create a Jinja2 page-template."""
    yield environment.get_template("page.html")


@pytest.fixture
 def article_template(environment: Environment) -> Iterator[Template]:
+    """Create a Jinja2 article-template."""
    yield environment.get_template("article.html")


@pytest.fixture
 def index_template(environment: Environment) -> Iterator[Template]:
+    """Create a Jinja2 index-template."""
    yield environment.get_template("index.html")


@pytest.fixture
 def archive_template(environment: Environment) -> Iterator[Template]:
+    """Create a Jinja2 archive-template."""
    yield environment.get_template("archive.html")


@pytest.fixture
 def tags_template(environment: Environment) -> Iterator[Template]:
+    """Create a Jinja2 tags-template."""
    yield environment.get_template("tags.html")


@pytest.fixture
 def tag_template(environment: Environment) -> Iterator[Template]:
+    """Create a Jinja2 tag-template."""
    yield environment.get_template("tag.html")


@@ -80,6 +86,7 @@ author = a. u. thor

@pytest.fixture
 def args(cleandir: Callable[[], Iterator[str]]) -> Iterator[Namespace]:
+    """Create a Namespace with default arguments."""
    args = Namespace(
        input_dir="content",
        output_dir="build",
--- a/tests/test_blag.py
+++ b/tests/test_blag.py
@@ -1,5 +1,4 @@
-# remove when we don't support py38 anymore
-from __future__ import annotations
+"""Test blag."""

 import os
 from argparse import Namespace
@@ -15,12 +14,14 @@ from blag import __VERSION__, blag


 def test_generate_feed(cleandir: str) -> None:
+    """Test generate_feed."""
    articles: list[tuple[str, dict[str, Any]]] = []
    blag.generate_feed(articles, "build", " ", " ", " ", " ")
    assert os.path.exists("build/atom.xml")


 def test_feed(cleandir: str) -> None:
+    """Test feed."""
    articles: list[tuple[str, dict[str, Any]]] = [
        (
            "dest1.html",
@@ -73,6 +74,7 @@ def test_feed(cleandir: str) -> None:


 def test_generate_feed_with_description(cleandir: str) -> None:
+    """Test generate_feed with description."""
    # if a description is provided, it will be used as the summary in
    # the feed, otherwise we simply use the title of the article
    articles: list[tuple[str, dict[str, Any]]] = [
@@ -98,6 +100,7 @@ def test_generate_feed_with_description(cleandir: str) -> None:


 def test_parse_args_build() -> None:
+    """Test parse_args with build."""
    # test default args
    args = blag.parse_args(["build"])
    assert args.input_dir == "content"
@@ -131,6 +134,7 @@ def test_parse_args_build() -> None:


 def test_get_config() -> None:
+    """Test get_config."""
    config = """
 [main]
 base_url = https://example.com/
@@ -180,6 +184,7 @@ author = a. u. thor


 def test_environment_factory(cleandir: str) -> None:
+    """Test environment_factory."""
    globals_: dict[str, object] = {"foo": "bar", "test": "me"}
    env = blag.environment_factory("templates", globals_=globals_)
    assert env.globals["foo"] == "bar"
@@ -191,6 +196,7 @@ def test_process_markdown(
    page_template: Template,
    article_template: Template,
 ) -> None:
+    """Test process_markdown."""
    page1 = """\
 title: some page

@@ -240,6 +246,7 @@ foo bar


 def test_build(args: Namespace) -> None:
+    """Test build."""
    page1 = """\
 title: some page

@@ -313,16 +320,19 @@ foo bar
    ],
 )
 def test_missing_template_raises(template: str, args: Namespace) -> None:
+    """Test that missing templates raise SystemExit."""
    os.remove(f"templates/{template}")
    with pytest.raises(SystemExit):
        blag.build(args)


 def test_main(cleandir: str) -> None:
+    """Test main."""
    blag.main(["build"])


 def test_cli_version(capsys: CaptureFixture[str]) -> None:
+    """Test --version."""
    with pytest.raises(SystemExit) as ex:
        blag.main(["--version"])
    # normal system exit
@@ -333,6 +343,7 @@ def test_cli_version(capsys: CaptureFixture[str]) -> None:


 def test_cli_verbose(cleandir: str, caplog: LogCaptureFixture) -> None:
+    """Test --verbose."""
    blag.main(["build"])
    assert "DEBUG" not in caplog.text

--- a/tests/test_devserver.py
+++ b/tests/test_devserver.py
@@ -1,27 +1,27 @@
-# remove when we don't support py38 anymore
-from __future__ import annotations
+"""Tests for the devserver module."""

 import threading
 import time
 from argparse import Namespace

-import pytest
-
 from blag import devserver

+WAITTIME = 0.1
+

 def test_get_last_modified(cleandir: str) -> None:
+    """Test get_last_modified."""
    # take initial time
    t1 = devserver.get_last_modified(["content"])

    # wait a bit, create a file and measure again
-    time.sleep(0.1)
+    time.sleep(WAITTIME)
    with open("content/test", "w") as fh:
        fh.write("boo")
    t2 = devserver.get_last_modified(["content"])

    # wait a bit and take time again
-    time.sleep(0.1)
+    time.sleep(WAITTIME)
    t3 = devserver.get_last_modified(["content"])

    assert t2 > t1
@@ -29,20 +29,21 @@ def test_get_last_modified(cleandir: str) -> None:


 def test_autoreload_builds_immediately(args: Namespace) -> None:
+    """Test autoreload builds immediately."""
    # create a dummy file that can be build
    with open("content/test.md", "w") as fh:
        fh.write("boo")

    t = threading.Thread(
        target=devserver.autoreload,
-        args=(args,),
+        args=(args, WAITTIME),
        daemon=True,
    )
    t0 = devserver.get_last_modified(["build"])
    t.start()
    # try for 5 seconds...
    for i in range(5):
-        time.sleep(1)
+        time.sleep(WAITTIME)
        t1 = devserver.get_last_modified(["build"])
        print(t1)
        if t1 > t0:
@@ -50,13 +51,11 @@ def test_autoreload_builds_immediately(args: Namespace) -> None:
    assert t1 > t0


-@pytest.mark.filterwarnings(
-    "ignore::pytest.PytestUnhandledThreadExceptionWarning"
-)
 def test_autoreload(args: Namespace) -> None:
+    """Test autoreload."""
    t = threading.Thread(
        target=devserver.autoreload,
-        args=(args,),
+        args=(args, WAITTIME),
        daemon=True,
    )
    t.start()
@@ -69,8 +68,32 @@ def test_autoreload(args: Namespace) -> None:

    # try for 5 seconds to see if we rebuild once...
    for i in range(5):
-        time.sleep(1)
+        time.sleep(WAITTIME)
        t1 = devserver.get_last_modified(["build"])
        if t1 > t0:
            break
    assert t1 > t0
+
+
+def test_autoreload_does_not_crash(args: Namespace) -> None:
+    """Test autoreload does not crash if build fails."""
+    t = threading.Thread(
+        target=devserver.autoreload,
+        args=(args, WAITTIME),
+        daemon=True,
+    )
+    t.start()
+
+    t0 = devserver.get_last_modified(["build"])
+
+    # create a file that causes build to crash
+    with open("content/test.md", "w") as fh:
+        fh.write("date: ")
+
+    # try for 5 seconds to see if we rebuild once...
+    for i in range(5):
+        time.sleep(WAITTIME)
+        t1 = devserver.get_last_modified(["build"])
+        if t1 > t0:
+            break
+    assert t.is_alive()
--- a/tests/test_markdown.py
+++ b/tests/test_markdown.py
@@ -1,5 +1,4 @@
-# remove when we don't support py38 anymore
-from __future__ import annotations
+"""Test markdown module."""

 from datetime import datetime
 from typing import Any
@@ -34,6 +33,7 @@ from blag.markdown import convert_markdown, markdown_factory
    ],
 )
 def test_convert_markdown_links(input_: str, expected: str) -> None:
+    """Test convert_markdown."""
    md = markdown_factory()
    html, _ = convert_markdown(md, input_)
    assert expected in html
@@ -51,6 +51,7 @@ def test_convert_markdown_links(input_: str, expected: str) -> None:
    ],
 )
 def test_dont_convert_normal_links(input_: str, expected: str) -> None:
+    """Test convert_markdown doesn't convert normal links."""
    md = markdown_factory()
    html, _ = convert_markdown(md, input_)
    assert expected in html
@@ -70,17 +71,20 @@ def test_dont_convert_normal_links(input_: str, expected: str) -> None:
    ],
 )
 def test_convert_metadata(input_: str, expected: dict[str, Any]) -> None:
+    """Test convert_markdown converts metadata correctly."""
    md = markdown_factory()
    _, meta = convert_markdown(md, input_)
    assert expected == meta


 def test_markdown_factory() -> None:
+    """Test markdown_factory."""
    md = markdown_factory()
    assert isinstance(md, markdown.Markdown)


 def test_smarty() -> None:
+    """Test smarty."""
    md = markdown_factory()

    md1 = """
@@ -95,6 +99,7 @@ this --- is -- a test ...


 def test_smarty_code() -> None:
+    """Test smarty doesn't touch code."""
    md = markdown_factory()

    md1 = """
--- a/tests/test_quickstart.py
+++ b/tests/test_quickstart.py
@@ -1,5 +1,4 @@
-# remove when we don't support py38 anymore
-from __future__ import annotations
+"""Tests for the quickstart module."""

 import os

@@ -9,21 +8,24 @@ from blag.quickstart import get_input, quickstart


 def test_get_input_default_answer(monkeypatch: MonkeyPatch) -> None:
+    """Test get_input with default answer."""
    monkeypatch.setattr("builtins.input", lambda x: "")
    answer = get_input("foo", "bar")
    assert answer == "bar"


 def test_get_input(monkeypatch: MonkeyPatch) -> None:
+    """Test get_input."""
    monkeypatch.setattr("builtins.input", lambda x: "baz")
    answer = get_input("foo", "bar")
    assert answer == "baz"


 def test_quickstart(cleandir: str, monkeypatch: MonkeyPatch) -> None:
+    """Test quickstart."""
    monkeypatch.setattr("builtins.input", lambda x: "foo")
    quickstart(None)
-    with open("config.ini", "r") as fh:
+    with open("config.ini") as fh:
        data = fh.read()
    assert "base_url = foo" in data
    assert "title = foo" in data
--- a/tests/test_templates.py
+++ b/tests/test_templates.py
@@ -1,5 +1,4 @@
-# remove when we don't support py38 anymore
-from __future__ import annotations
+"""Test the templates."""

 import datetime

@@ -7,6 +6,7 @@ from jinja2 import Template


 def test_page(page_template: Template) -> None:
+    """Test the page template."""
    ctx = {
        "content": "this is the content",
        "title": "this is the title",
@@ -17,6 +17,7 @@ def test_page(page_template: Template) -> None:


 def test_article(article_template: Template) -> None:
+    """Test the article template."""
    ctx = {
        "content": "this is the content",
        "title": "this is the title",
@@ -29,6 +30,7 @@ def test_article(article_template: Template) -> None:


 def test_index(index_template: Template) -> None:
+    """Test the index template."""
    entry = {
        "title": "this is a title",
        "dst": "https://example.com/link",
@@ -49,6 +51,7 @@ def test_index(index_template: Template) -> None:


 def test_archive(archive_template: Template) -> None:
+    """Test the archive template."""
    entry = {
        "title": "this is a title",
        "dst": "https://example.com/link",
@@ -67,6 +70,7 @@ def test_archive(archive_template: Template) -> None:


 def test_tags(tags_template: Template) -> None:
+    """Test the tags template."""
    tags = [("foo", 42)]
    ctx = {
        "tags": tags,
@@ -80,6 +84,7 @@ def test_tags(tags_template: Template) -> None:


 def test_tag(tag_template: Template) -> None:
+    """Test the tag template."""
    entry = {
        "title": "this is a title",
        "dst": "https://example.com/link",
--- a/tests/test_version.py
+++ b/tests/test_version.py
@@ -1,8 +1,8 @@
-# remove when we don't support py38 anymore
-from __future__ import annotations
+"""Test the version module."""

 import blag


 def test_version() -> None:
+    """Test the version of the package."""
    assert isinstance(blag.__VERSION__, str)