Compare commits

..

14 Commits

Author SHA1 Message Date
Bastian Venthur
60bd86ec22 finalized benchmark 2025-01-22 15:17:28 +01:00
Bastian Venthur
69b729a471 Merge branch 'performance' into rebuild_needed_only 2025-01-22 14:46:42 +01:00
Bastian Venthur
f09e841200 Merge branch 'master' into rebuild_needed_only 2025-01-22 14:46:29 +01:00
Bastian Venthur
c94f9793b0 improved performance test 2025-01-22 14:46:14 +01:00
Bastian Venthur
5cddb62603 Merge branch 'master' into performance 2025-01-22 14:14:46 +01:00
Bastian Venthur
85e57a7ef2 added py313 to github actions test suite 2025-01-03 10:46:22 +01:00
dependabot[bot]
ef18685cef Bump the all group across 1 directory with 10 updates
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>
2024-12-23 14:19:20 +00:00
Bastian Venthur
6b699f58ad simplified color scheme selection 2024-11-18 09:22:21 +01:00
Bastian Venthur
a3da95ea19 added benchmark 2024-10-29 12:13:05 +01:00
Bastian Venthur
c4f3c09730 WIP 2024-10-29 10:16:48 +01:00
Bastian Venthur
5943dab690 wip 2024-10-29 10:16:48 +01:00
Bastian Venthur
71c866c9b3 Merge branch 'master' into rebuild_needed_only 2023-11-12 17:16:46 +01:00
Bastian Venthur
c87a300c71 Merge branch 'master' into rebuild_needed_only 2022-08-07 21:50:15 +02:00
Bastian Venthur
a939e6503c rebuild only files that need re-building
we compare the mtimes of src and dst
2022-08-06 21:56:41 +02:00
12 changed files with 166 additions and 91 deletions

View File

@@ -1,38 +0,0 @@
name: CI/CD Pipeline
on:
push:
branches:
- main
tags:
- "v**"
jobs:
job1:
runs-on: ubuntu-latest
steps:
- uses: https://github.com/actions/checkout@v4
- uses: https://github.com/actions/setup-python@v5
with:
python-version: "3.11"
- run: |
make venv
- run: |
make lint
- run: |
make mypy
- run: |
make test
- run: |
make test-release
-
name: Push to docker pypi registry.
env:
TWINE_USERNAME: ${{ secrets.REGISTRY_USERNAME }}
TWINE_PASSWORD: ${{ secrets.REGISTRY_TOKEN }}
TWINE_REPOSITORY_URL: "https://gitea.raer.me/api/packages/freyjagp/pypi"
run: |
venv/bin/python3 -m twine upload --verbose dist/*

15
.github/dependabot.yml vendored Normal file
View File

@@ -0,0 +1,15 @@
version: 2
updates:
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
groups:
all:
patterns:
- "*"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"

77
.github/workflows/python-package.yaml vendored Normal file
View File

@@ -0,0 +1,77 @@
name: CI/CD Pipeline
on:
- push
- pull_request
jobs:
test:
name: Test Python ${{ matrix.python-version }} on ${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os:
- ubuntu-latest
- macos-latest
- windows-latest
python-version:
- "3.10"
- "3.11"
- "3.12"
- "3.13"
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- run: |
make venv
- run: |
make test
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.x"
- run: |
make venv
- run: |
make lint
mypy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.x"
- run: |
make venv
- run: |
make mypy
test-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.x"
- run: |
make venv
- run: |
make test-release

View File

@@ -1,21 +1,9 @@
# Changelog
## [unreleased]
* Added Python 3.13 to github actions
## [2.4.0] -- 2024-10-26
* Merged original dev's work on v2.3.x into my fork.
## [2.4.0] -- 2024-10-26
* Merged master (original dev's work) into main (my fork)
* update gitea workflow to hopefully build/push any updates made to my fork of blag.
## [2.4.0] -- 2024-09-05
* added strikethru and footnotes to blag renders.
## [unreleased] --
## [2.3.2] -- 2024-10-13
* Ignore FileNotFoundError when trying to get the last modified time of files

View File

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

View File

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

View File

@@ -30,8 +30,6 @@ def markdown_factory() -> Markdown:
"""
md = Markdown(
extensions=[
"footnotes", # Add footnotes support
"pymdownx.tilde", # Add strukethrough support
"meta",
"fenced_code",
"codehilite",

View File

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

View File

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

View File

@@ -1,11 +1,11 @@
build==1.2.2.post1
mkdocs==1.6.1
mkdocs-material==9.5.39
mkdocstrings[python]==0.26.1
twine==5.1.1
wheel==0.44.0
pytest==8.3.3
pytest-cov==5.0.0
ruff==0.6.9
mypy==1.11.2
types-markdown==3.7.0.20240822
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

View File

@@ -1,5 +1,4 @@
markdown==3.7
feedgenerator==2.1.0
jinja2==3.1.4
jinja2==3.1.5
pygments==2.18.0
pymdown-extensions==10.9

37
tests/benchmark.py Normal file
View File

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