finalized benchmark

we compare the mtimes of src and dst

.github/workflows/python-package.yaml

@@ -1,9 +1,12 @@
+name: CI/CD Pipeline
+
 on:
   - push
   - pull_request
 
 jobs:
   test:
+    name: Test Python ${{ matrix.python-version }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
 
     strategy:
@@ -20,7 +23,7 @@ jobs:
           - "3.13"
 
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v4
     - uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
@@ -34,7 +37,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v4
     - uses: actions/setup-python@v5
       with:
         python-version: "3.x"
@@ -48,7 +51,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v4
     - uses: actions/setup-python@v5
       with:
         python-version: "3.x"
@@ -63,7 +66,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v4
     - uses: actions/setup-python@v5
       with:
         python-version: "3.x"

.readthedocs.yaml

@@ -3,13 +3,13 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.12"
+    python: "3.11"
 
 mkdocs:
   configuration: mkdocs.yml
 
 python:
   install:
-    - path: .
-      extra_requirements:
-        - dev
+  - requirements: requirements.txt
+  - requirements: requirements-dev.txt
+  - path: .

CHANGELOG.md

@@ -1,16 +1,8 @@
 # Changelog
 
-## [unreleased] --
+## [unreleased]
 
-* Removed requirements.txt and requirements-dev.txt
-
-## [2.3.3] -- 2025-04-27
-
-* Fixed Atom feed encoding to 'utf-8'
 * Added Python 3.13 to github actions
-* `requirements*.txt` files are handled by pip-tools. Updates are handled by
-  make update-requirements based on the dependencies described in the
-  pyproject.toml
 
 ## [2.3.2] -- 2024-10-13
 

Makefile

@@ -16,9 +16,11 @@ endif
 .PHONY: all
 all: lint mypy test test-release
 
-$(VENV): pyproject.toml
+$(VENV): requirements.txt requirements-dev.txt pyproject.toml
 	$(PY) -m venv $(VENV)
-	$(BIN)/pip install --upgrade -e .['dev']
+	$(BIN)/pip install --upgrade -r requirements.txt
+	$(BIN)/pip install --upgrade -r requirements-dev.txt
+	$(BIN)/pip install -e .['dev']
 	touch $(VENV)
 
 .PHONY: test
@@ -63,6 +65,10 @@ serve-docs: $(VENV)
 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

blag/blag.py

@@ -323,6 +323,18 @@ def process_markdown(
     for src, dst in convertibles:
         logger.debug(f"Processing {src}")
 
+        # 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()
 
@@ -396,7 +408,7 @@ def generate_feed(
         )
 
     with open(f"{output_dir}/atom.xml", "w") as fh:
-        feed.write(fh, encoding='utf-8')
+        feed.write(fh, encoding="utf8")
 
 
 def generate_index(

blag/version.py

@@ -1,3 +1,3 @@
 """Version information for the blag package."""
 
-__VERSION__ = "2.3.3"
+__VERSION__ = "2.3.2"

debian/changelog

@@ -1,13 +1,3 @@
-blag (2.3.3) unstable; urgency=medium
-
-  * Fixed Atom feed encoding to 'utf-8'
-  * Added Python 3.13 to github actions
-  * `requirements*.txt` files are handled by pip-tools. Updates are handled by
-    make update-requirements based on the dependencies described in the
-    pyproject.toml
-
- -- Bastian Venthur <venthur@debian.org>  Sun, 27 Apr 2025 11:42:13 +0200
-
 blag (2.3.2) unstable; urgency=medium
 
   * Ignore FileNotFoundError when trying to get the last modified time of

pyproject.toml

@@ -10,13 +10,13 @@ authors = [
 description = "blog-aware, static site generator"
 keywords = ["markdown", "blag", "blog", "static site generator", "cli"]
 readme = "README.md"
-license-files = ["LICENSE"]
+license = { file="LICENSE" }
 requires-python = ">=3.10"
 dynamic = ["version"]
 dependencies = [
+    "markdown",
     "feedgenerator",
     "jinja2",
-    "markdown",
     "pygments",
 ]
 
@@ -34,13 +34,13 @@ dev = [
     "mkdocs",
     "mkdocs-material",
     "mkdocstrings[python]",
-    "mypy",
+    "twine",
+    "wheel",
     "pytest",
     "pytest-cov",
     "ruff",
-    "twine",
+    "mypy",
     "types-markdown",
-    "wheel",
 ]
 
 [tool.setuptools.dynamic]

requirements-dev.txt

@@ -0,0 +1,11 @@
+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

requirements.txt

@@ -0,0 +1,4 @@
+markdown==3.7
+feedgenerator==2.1.0
+jinja2==3.1.5
+pygments==2.18.0

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}")

tests/test_blag.py

@@ -99,15 +99,6 @@ def test_generate_feed_with_description(cleandir: str) -> None:
     assert '<content type="html">content' in feed
 
 
-def test_feed_is_unicode(cleandir: str) -> None:
-    """Test generate_feed."""
-    articles: list[tuple[str, dict[str, Any]]] = []
-    blag.generate_feed(articles, "build", " ", " ", " ", " ")
-    with open("build/atom.xml") as fh:
-        feed = fh.read()
-    assert 'encoding="utf-8"' in feed
-
-
 def test_parse_args_build() -> None:
     """Test parse_args with build."""
     # test default args