Add repo markdown rendering

Author: sco1

.flake8

@@ -10,4 +10,4 @@ extend-ignore=
 extend-exclude=
     .venv,
 per-file-ignores =
-    tests/test_*.py:E501,
+    tests/test_*.py:E501,W291,

.pre-commit-config.yaml

@@ -28,6 +28,7 @@ repos:
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: trailing-whitespace
+        exclude: "test_render.py"
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.10.0
     hooks:

README.md

@@ -1,6 +1,7 @@
 # readme-rel
-[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-black)](https://github.com/psf/black)
+[![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fsco1%2Freadme-rel%2Frefs%2Fheads%2Fmain%2Fpyproject.toml&logo=python&logoColor=FFD43B)](https://github.com/sco1/readme-rel/blob/main/pyproject.toml)
+[![GitHub License](https://img.shields.io/github/license/sco1/readme-rel?color=magenta)](https://github.com/sco1/readme-rel/blob/main/LICENSE)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sco1/readme-rel/main.svg)](https://results.pre-commit.ci/latest/github/sco1/readme-rel/main)
 
 Bump recent releases in my [personal README](https://github.com/sco1/sco1/blob/master/README.md)
 

readme_rel/main.py

@@ -3,6 +3,7 @@
 import datetime as dt
 import operator
 import os
+from collections import abc
 from dataclasses import dataclass
 
 from gql import Client, gql
@@ -172,5 +173,16 @@ def n_recent_releases(n: int = 5) -> list[Repository]:
     return repositories[:n]
 
 
-if __name__ == "__main__":
-    n_recent_releases()
+def render_repos(repos: abc.Iterable[Repository]) -> str:
+    repo_strings = []
+    for r in repos:
+        repo_url = f"[`{r.name}`]({r.url})"
+        tree_url = f"[Tree]({r.url}/tree/{r.last_release.tag_name})"
+        changelog_url = f"[Changelog]({r.last_release.url})"
+        publish_str = r.last_release.published.strftime(r"%Y-%m-%d")
+
+        # fmt: off
+        repo_strings.append(f"* {publish_str}: {repo_url} `{r.last_release.tag_name}` ({changelog_url}, {tree_url})  ")  # noqa: E501
+        # fmt: on
+
+    return "\n".join(repo_strings)

tests/test_render.py

@@ -0,0 +1,47 @@
+import datetime as dt
+
+from readme_rel.main import Release, Repository, render_repos
+
+SAMPLE_REPOS = [
+    Repository(  # Page 1
+        name="xbmini-py",
+        url="https://github.com/sco1/xbmini-py",
+        n_releases=5,
+        last_release=Release(
+            tag_name="v0.5.0",
+            published=dt.datetime.fromisoformat("2025-01-06T20:44:16Z"),
+            url="https://github.com/sco1/xbmini-py/releases/tag/v0.5.0",
+        ),
+    ),
+    Repository(  # Page 2
+        name="matplotlib-window",
+        url="https://github.com/sco1/matplotlib-window",
+        n_releases=3,
+        last_release=Release(
+            tag_name="v1.1.0",
+            published=dt.datetime.fromisoformat("2024-12-31T01:26:50Z"),
+            url="https://github.com/sco1/matplotlib-window/releases/tag/v1.1.0",
+        ),
+    ),
+    Repository(  # Page 1
+        name="pyflysight",
+        url="https://github.com/sco1/pyflysight",
+        n_releases=9,
+        last_release=Release(
+            tag_name="v0.9.0",
+            published=dt.datetime.fromisoformat("2024-11-27T17:52:24Z"),
+            url="https://github.com/sco1/pyflysight/releases/tag/v0.9.0",
+        ),
+    ),
+]
+
+# fmt: off
+TRUTH_RENDERED = """\
+* 2025-01-06: [`xbmini-py`](https://github.com/sco1/xbmini-py) `v0.5.0` ([Changelog](https://github.com/sco1/xbmini-py/releases/tag/v0.5.0), [Tree](https://github.com/sco1/xbmini-py/tree/v0.5.0))  
+* 2024-12-31: [`matplotlib-window`](https://github.com/sco1/matplotlib-window) `v1.1.0` ([Changelog](https://github.com/sco1/matplotlib-window/releases/tag/v1.1.0), [Tree](https://github.com/sco1/matplotlib-window/tree/v1.1.0))  
+* 2024-11-27: [`pyflysight`](https://github.com/sco1/pyflysight) `v0.9.0` ([Changelog](https://github.com/sco1/pyflysight/releases/tag/v0.9.0), [Tree](https://github.com/sco1/pyflysight/tree/v0.9.0))  """
+# fmt: on
+
+
+def test_render_repos() -> None:
+    assert render_repos(SAMPLE_REPOS) == TRUTH_RENDERED