Merge branch 'template'

.github/workflows/check.yaml

@@ -71,8 +71,8 @@ jobs:
         uses: liskin/gh-problem-matcher-wrap@v2
         with:
           linters: pytest
-          run: make test
-      - name: readme
+          run: make test-pytest
+      - name: cram, readme
         run: make readme
       - name: check-wheel
         run: make check-wheel
@@ -139,8 +139,8 @@ jobs:
         uses: liskin/gh-problem-matcher-wrap@v2
         with:
           linters: pytest
-          run: make test
-      - name: readme
+          run: make test-pytest
+      - name: cram, readme
         run: make readme
       - name: check-wheel
         run: make check-wheel

.gitignore

@@ -1,4 +1,5 @@
 *.egg-info/
+*.md.err
 /.*_cache/
 /.venv/
 /build/

Makefile

@@ -48,26 +48,28 @@ lint-isort: $(VENV_DONE)
 	$(VENV_PYTHON) -m isort --check $(LINT_SOURCES)
 
 .PHONY: test
-test: $(VENV_DONE)
+test: test-pytest test-cram
+
+.PHONY: test-pytest
+test-pytest: $(VENV_DONE)
 	$(VENV_PYTHON) -m pytest $(PYTEST_FLAGS) tests/
 
 .PHONY: readme
 readme: README.md
 	git diff --exit-code $^
 
-CRAM_TARGETS := $(wildcard .readme.md/*.md)
-
-.PHONY: $(CRAM_TARGETS)
-$(CRAM_TARGETS) &: CRAM_INTERACTIVE=$(shell [ -t 0 ] && echo --interactive)
-$(CRAM_TARGETS) &: $(VENV_DONE)
+.PHONY: test-cram
+test-cram: CRAM_INTERACTIVE=$(shell [ -t 0 ] && echo --interactive)
+test-cram: $(VENV_DONE)
 	PATH="$(CURDIR)/$(VENV)/bin:$$PATH" \
 	XDG_DATA_HOME=/home/user/.local/share \
 	XDG_CONFIG_HOME=/home/user/.config \
-	$(VENV_PYTHON) -m cram --indent=4 $(CRAM_INTERACTIVE) $(CRAM_TARGETS)
+	$(VENV_PYTHON) tests/cram-noescape.py --indent=4 --shell=/bin/bash $(CRAM_INTERACTIVE) \
+		$(wildcard tests/*.md tests/*/*.md tests/*/*/*.md)
 
 .PHONY: README.md
-README.md: $(CRAM_TARGETS)
-	.readme.md/include.py < $@ > $@.tmp
+README.md: test-cram
+	tests/include.py < $@ > $@.tmp
 	mv -f $@.tmp $@
 
 .PHONY: dist

README.md

@@ -92,7 +92,7 @@ pip install strava-offline
 
 ### Mirror activities metadata
 
-<!-- include .readme.md/help-sqlite.md -->
+<!-- include tests/readme/help-sqlite.md -->
     $ strava-offline sqlite --help
     Usage: strava-offline sqlite [OPTIONS]
 
@@ -131,7 +131,7 @@ least once to let strava-offline reuse these downloaded files.
 
 [strava-bulk-export]: https://support.strava.com/hc/en-us/articles/216918437-Exporting-your-Data-and-Bulk-Export#Bulk
 
-<!-- include .readme.md/help-gpx.md -->
+<!-- include tests/readme/help-gpx.md -->
     $ strava-offline gpx --help
     Usage: strava-offline gpx [OPTIONS]
 
@@ -164,7 +164,7 @@ least once to let strava-offline reuse these downloaded files.
 
 ### Reports
 
-<!-- include .readme.md/help-report.md -->
+<!-- include tests/readme/help-report.md -->
     $ strava-offline --help | grep report-
       report-bikes         Show all-time report by bike
       report-yearly        Show yearly report by activity type
@@ -191,7 +191,7 @@ which is located at `~/.config/strava_offline/config.yaml` by default
 
 Sample config file can be generated using the `--config-sample` flag:
 
-<!-- include .readme.md/config-sample.md -->
+<!-- include tests/readme/config-sample.md -->
     $ strava-offline --config-sample
     # Perform full sync instead of incremental
     full: false

pyproject.toml

@@ -107,4 +107,7 @@ show_error_codes = true
 [tool.isort]
 profile = "open_stack"
 
+[tool.ruff]
+line-length = 120
+
 # vim:set et:

tests/cram-noescape.py

@@ -0,0 +1,8 @@
+#!/usr/bin/env python3
+
+import runpy
+
+import cram  # type: ignore [import]
+
+cram._test._needescape = lambda _: False
+runpy.run_module('cram')