finalized benchmark

Bumps the all group with 10 updates in the / directory:

| Package | From | To |
| --- | --- | --- |
| [mkdocs-material](https://github.com/squidfunk/mkdocs-material) | `9.5.39` | `9.5.49` |
| [mkdocstrings[python]](https://github.com/mkdocstrings/mkdocstrings) | `0.26.1` | `0.27.0` |
| [twine](https://github.com/pypa/twine) | `5.1.1` | `6.0.1` |
| [wheel](https://github.com/pypa/wheel) | `0.44.0` | `0.45.1` |
| [pytest](https://github.com/pytest-dev/pytest) | `8.3.3` | `8.3.4` |
| [pytest-cov](https://github.com/pytest-dev/pytest-cov) | `5.0.0` | `6.0.0` |
| [ruff](https://github.com/astral-sh/ruff) | `0.6.9` | `0.8.4` |
| [mypy](https://github.com/python/mypy) | `1.11.2` | `1.14.0` |
| [types-markdown](https://github.com/python/typeshed) | `3.7.0.20240822` | `3.7.0.20241204` |
| [jinja2](https://github.com/pallets/jinja) | `3.1.4` | `3.1.5` |



Updates `mkdocs-material` from 9.5.39 to 9.5.49
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.39...9.5.49)

Updates `mkdocstrings[python]` from 0.26.1 to 0.27.0
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](https://github.com/mkdocstrings/mkdocstrings/compare/0.26.1...0.27.0)

Updates `twine` from 5.1.1 to 6.0.1
- [Release notes](https://github.com/pypa/twine/releases)
- [Changelog](https://github.com/pypa/twine/blob/main/docs/changelog.rst)
- [Commits](https://github.com/pypa/twine/compare/v5.1.1...6.0.1)

Updates `wheel` from 0.44.0 to 0.45.1
- [Release notes](https://github.com/pypa/wheel/releases)
- [Changelog](https://github.com/pypa/wheel/blob/main/docs/news.rst)
- [Commits](https://github.com/pypa/wheel/compare/0.44.0...0.45.1)

Updates `pytest` from 8.3.3 to 8.3.4
- [Release notes](https://github.com/pytest-dev/pytest/releases)
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pytest-dev/pytest/compare/8.3.3...8.3.4)

Updates `pytest-cov` from 5.0.0 to 6.0.0
- [Changelog](https://github.com/pytest-dev/pytest-cov/blob/master/CHANGELOG.rst)
- [Commits](https://github.com/pytest-dev/pytest-cov/compare/v5.0.0...v6.0.0)

Updates `ruff` from 0.6.9 to 0.8.4
- [Release notes](https://github.com/astral-sh/ruff/releases)
- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md)
- [Commits](https://github.com/astral-sh/ruff/compare/0.6.9...0.8.4)

Updates `mypy` from 1.11.2 to 1.14.0
- [Changelog](https://github.com/python/mypy/blob/master/CHANGELOG.md)
- [Commits](https://github.com/python/mypy/compare/v1.11.2...v1.14.0)

Updates `types-markdown` from 3.7.0.20240822 to 3.7.0.20241204
- [Commits](https://github.com/python/typeshed/commits)

Updates `jinja2` from 3.1.4 to 3.1.5
- [Release notes](https://github.com/pallets/jinja/releases)
- [Changelog](https://github.com/pallets/jinja/blob/main/CHANGES.rst)
- [Commits](https://github.com/pallets/jinja/compare/3.1.4...3.1.5)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: mkdocstrings[python]
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: all
- dependency-name: twine
  dependency-type: direct:development
  update-type: version-update:semver-major
  dependency-group: all
- dependency-name: wheel
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: all
- dependency-name: pytest
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: pytest-cov
  dependency-type: direct:development
  update-type: version-update:semver-major
  dependency-group: all
- dependency-name: ruff
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: all
- dependency-name: mypy
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: all
- dependency-name: types-markdown
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: jinja2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: all
...

Signed-off-by: dependabot[bot] <support@github.com>

.github/dependabot.yml

@@ -4,6 +4,10 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    groups:
+      all:
+        patterns:
+          - "*"
 
   - package-ecosystem: "github-actions"
     directory: "/"

.github/workflows/python-package.yaml

@@ -20,6 +20,7 @@ jobs:
           - "3.10"
           - "3.11"
           - "3.12"
+          - "3.13"
 
     steps:
     - uses: actions/checkout@v4

CHANGELOG.md

@@ -1,5 +1,28 @@
 # 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

Makefile

@@ -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

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()
 

blag/devserver.py

@@ -42,7 +42,12 @@ 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
 

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;

blag/version.py

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

debian/blag-doc.docs

@@ -1 +1 @@
-site/
+site/*

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.

debian/changelog

@@ -1,3 +1,26 @@
+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

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,8 +28,8 @@ Vcs-Git: https://github.com/venthur/blag.git
 Package: blag
 Architecture: all
 Depends:
- ${python3:Depends},
  ${misc:Depends},
+ ${python3:Depends},
 Suggests:
  blag-doc,
 Description: Blog-aware, static site generator

debian/manpages

@@ -0,0 +1 @@
+debian/blag.1

docs/CHANGELOG.md

@@ -0,0 +1 @@
+../CHANGELOG.md

docs/index.md

@@ -16,7 +16,7 @@ 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
@@ -24,7 +24,7 @@ blag is named after [the blag of the webcomic xkcd][blagxkcd].
 * 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/

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

pyproject.toml

@@ -65,7 +65,6 @@ addopts = """
 
 [tool.ruff]
 line-length = 79
-target-version = "py310"
 
 [tool.ruff.lint]
 select = [

requirements-dev.txt

@@ -1,11 +1,11 @@
-build==1.0.3
-mkdocs==1.5.3
-mkdocs-material==9.5.18
-mkdocstrings[python]==0.24.3
-twine==5.0.0
-wheel==0.42.0
-pytest==8.1.1
-pytest-cov==4.1.0
-ruff==0.4.1
-mypy==1.8.0
-types-markdown==3.5.0.20240129
+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

@@ -1,4 +1,4 @@
-markdown==3.5.2
+markdown==3.7
 feedgenerator==2.1.0
-jinja2==3.1.3
-pygments==2.17.2
+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}")