mirror of
https://github.com/venthur/blag.git
synced 2025-11-26 05:02:58 +00:00
Compare commits
20 Commits
rebuild_ne
...
performanc
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f707f33fbc | ||
|
|
3c617acfaf | ||
|
|
41b0962ec0 | ||
|
|
720a92d72d | ||
|
|
9b11c67253 | ||
|
|
ce0f9f6fa7 | ||
|
|
ba4bf8481c | ||
|
|
ae544e3d02 | ||
|
|
904f231754 | ||
|
|
87a6ff09d5 | ||
|
|
419b0aea3a | ||
|
|
b0139dad8d | ||
|
|
05af204254 | ||
|
|
031e3f92cd | ||
|
|
729b1acf65 | ||
|
|
d8c41cc9fb | ||
|
|
00e02f13dc | ||
|
|
5c7213eac0 | ||
|
|
8a275c0923 | ||
|
|
abf7dc0485 |
3
.github/workflows/python-package.yaml
vendored
3
.github/workflows/python-package.yaml
vendored
@@ -1,12 +1,9 @@
|
|||||||
name: CI/CD Pipeline
|
|
||||||
|
|
||||||
on:
|
on:
|
||||||
- push
|
- push
|
||||||
- pull_request
|
- pull_request
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
test:
|
test:
|
||||||
name: Test Python ${{ matrix.python-version }} on ${{ matrix.os }}
|
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
|
|
||||||
strategy:
|
strategy:
|
||||||
|
|||||||
@@ -3,13 +3,13 @@ version: 2
|
|||||||
build:
|
build:
|
||||||
os: ubuntu-22.04
|
os: ubuntu-22.04
|
||||||
tools:
|
tools:
|
||||||
python: "3.11"
|
python: "3.12"
|
||||||
|
|
||||||
mkdocs:
|
mkdocs:
|
||||||
configuration: mkdocs.yml
|
configuration: mkdocs.yml
|
||||||
|
|
||||||
python:
|
python:
|
||||||
install:
|
install:
|
||||||
- requirements: requirements.txt
|
|
||||||
- requirements: requirements-dev.txt
|
|
||||||
- path: .
|
- path: .
|
||||||
|
extra_requirements:
|
||||||
|
- dev
|
||||||
|
|||||||
10
CHANGELOG.md
10
CHANGELOG.md
@@ -1,8 +1,16 @@
|
|||||||
# Changelog
|
# 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
|
* 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
|
## [2.3.2] -- 2024-10-13
|
||||||
|
|
||||||
|
|||||||
8
Makefile
8
Makefile
@@ -16,11 +16,9 @@ endif
|
|||||||
.PHONY: all
|
.PHONY: all
|
||||||
all: lint mypy test test-release
|
all: lint mypy test test-release
|
||||||
|
|
||||||
$(VENV): requirements.txt requirements-dev.txt pyproject.toml
|
$(VENV): pyproject.toml
|
||||||
$(PY) -m venv $(VENV)
|
$(PY) -m venv $(VENV)
|
||||||
$(BIN)/pip install --upgrade -r requirements.txt
|
$(BIN)/pip install --upgrade -e .['dev']
|
||||||
$(BIN)/pip install --upgrade -r requirements-dev.txt
|
|
||||||
$(BIN)/pip install -e .['dev']
|
|
||||||
touch $(VENV)
|
touch $(VENV)
|
||||||
|
|
||||||
.PHONY: test
|
.PHONY: test
|
||||||
@@ -67,7 +65,7 @@ manpage: $(VENV)
|
|||||||
|
|
||||||
.PHONY: benchmark
|
.PHONY: benchmark
|
||||||
benchmark: $(VENV)
|
benchmark: $(VENV)
|
||||||
$(BIN)/pytest --no-cov -capture=no -rA tests/benchmark.py
|
$(BIN)/pytest --no-cov -s -rP tests/benchmark.py
|
||||||
|
|
||||||
.PHONY: clean
|
.PHONY: clean
|
||||||
clean:
|
clean:
|
||||||
|
|||||||
14
blag/blag.py
14
blag/blag.py
@@ -323,18 +323,6 @@ def process_markdown(
|
|||||||
for src, dst in convertibles:
|
for src, dst in convertibles:
|
||||||
logger.debug(f"Processing {src}")
|
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:
|
with open(f"{input_dir}/{src}") as fh:
|
||||||
body = fh.read()
|
body = fh.read()
|
||||||
|
|
||||||
@@ -408,7 +396,7 @@ def generate_feed(
|
|||||||
)
|
)
|
||||||
|
|
||||||
with open(f"{output_dir}/atom.xml", "w") as fh:
|
with open(f"{output_dir}/atom.xml", "w") as fh:
|
||||||
feed.write(fh, encoding="utf8")
|
feed.write(fh, encoding='utf-8')
|
||||||
|
|
||||||
|
|
||||||
def generate_index(
|
def generate_index(
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
"""Version information for the blag package."""
|
"""Version information for the blag package."""
|
||||||
|
|
||||||
__VERSION__ = "2.3.2"
|
__VERSION__ = "2.3.3"
|
||||||
|
|||||||
10
debian/changelog
vendored
10
debian/changelog
vendored
@@ -1,3 +1,13 @@
|
|||||||
|
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
|
blag (2.3.2) unstable; urgency=medium
|
||||||
|
|
||||||
* Ignore FileNotFoundError when trying to get the last modified time of
|
* Ignore FileNotFoundError when trying to get the last modified time of
|
||||||
|
|||||||
@@ -10,13 +10,13 @@ authors = [
|
|||||||
description = "blog-aware, static site generator"
|
description = "blog-aware, static site generator"
|
||||||
keywords = ["markdown", "blag", "blog", "static site generator", "cli"]
|
keywords = ["markdown", "blag", "blog", "static site generator", "cli"]
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
license = { file="LICENSE" }
|
license-files = ["LICENSE"]
|
||||||
requires-python = ">=3.10"
|
requires-python = ">=3.10"
|
||||||
dynamic = ["version"]
|
dynamic = ["version"]
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"markdown",
|
|
||||||
"feedgenerator",
|
"feedgenerator",
|
||||||
"jinja2",
|
"jinja2",
|
||||||
|
"markdown",
|
||||||
"pygments",
|
"pygments",
|
||||||
]
|
]
|
||||||
|
|
||||||
@@ -34,13 +34,13 @@ dev = [
|
|||||||
"mkdocs",
|
"mkdocs",
|
||||||
"mkdocs-material",
|
"mkdocs-material",
|
||||||
"mkdocstrings[python]",
|
"mkdocstrings[python]",
|
||||||
"twine",
|
"mypy",
|
||||||
"wheel",
|
|
||||||
"pytest",
|
"pytest",
|
||||||
"pytest-cov",
|
"pytest-cov",
|
||||||
"ruff",
|
"ruff",
|
||||||
"mypy",
|
"twine",
|
||||||
"types-markdown",
|
"types-markdown",
|
||||||
|
"wheel",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.setuptools.dynamic]
|
[tool.setuptools.dynamic]
|
||||||
|
|||||||
@@ -1,11 +0,0 @@
|
|||||||
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
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
markdown==3.7
|
|
||||||
feedgenerator==2.1.0
|
|
||||||
jinja2==3.1.5
|
|
||||||
pygments==2.18.0
|
|
||||||
@@ -1,21 +1,21 @@
|
|||||||
"""Benchmark the performance of the blag build command."""
|
"""Benchmark for Blag."""
|
||||||
|
|
||||||
import logging
|
|
||||||
import os
|
import os
|
||||||
from argparse import Namespace
|
from argparse import Namespace
|
||||||
|
|
||||||
from pytest import LogCaptureFixture
|
|
||||||
|
|
||||||
import blag
|
import blag
|
||||||
from blag.blag import build
|
from blag.blag import build
|
||||||
|
|
||||||
|
|
||||||
def test_performance(args: Namespace, caplog: LogCaptureFixture) -> None:
|
def test_performance(args: Namespace) -> None:
|
||||||
"""Test performance of the build command."""
|
"""Test performance.
|
||||||
caplog.set_level(logging.ERROR)
|
|
||||||
|
|
||||||
FILES = 10000
|
This test checks how quickly blag can generate `FILES` amount of pages from
|
||||||
print(f"Generating {FILES} markdown files")
|
markdown.
|
||||||
|
|
||||||
|
"""
|
||||||
|
FILES = 1000
|
||||||
|
print(f"Generating {FILES} files")
|
||||||
# create random markdown files in the content directory
|
# create random markdown files in the content directory
|
||||||
with open(os.path.join(blag.__path__[0], "content", "testpage.md")) as fh:
|
with open(os.path.join(blag.__path__[0], "content", "testpage.md")) as fh:
|
||||||
markdown = fh.read()
|
markdown = fh.read()
|
||||||
@@ -29,9 +29,12 @@ def test_performance(args: Namespace, caplog: LogCaptureFixture) -> None:
|
|||||||
t = time()
|
t = time()
|
||||||
build(args)
|
build(args)
|
||||||
t_first = time() - t
|
t_first = time() - t
|
||||||
|
print(t_first)
|
||||||
|
|
||||||
t = time()
|
t = time()
|
||||||
build(args)
|
build(args)
|
||||||
t_second = time() - t
|
t_second = time() - t
|
||||||
|
print(t_second)
|
||||||
print(f"First run: {t_first:.2f}s, second run: {t_second:.2f}s")
|
print(f"First run: {t_first:.2f}s, second run: {t_second:.2f}s")
|
||||||
print(f"Speedup: {t_first/t_second:.2f}")
|
print(f"Speedup: {t_first/t_second:.2f}")
|
||||||
|
|
||||||
|
|||||||
@@ -99,6 +99,15 @@ def test_generate_feed_with_description(cleandir: str) -> None:
|
|||||||
assert '<content type="html">content' in feed
|
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:
|
def test_parse_args_build() -> None:
|
||||||
"""Test parse_args with build."""
|
"""Test parse_args with build."""
|
||||||
# test default args
|
# test default args
|
||||||
|
|||||||
Reference in New Issue
Block a user