Add an "author" resource type.

Author: pauleveritt

src/psc/gallery/authors/meg-1.md

@@ -0,0 +1,6 @@
+---
+title: Margaret
+---
+
+An I.T. student.
+Currently focusing on programming with Python and learning Django development.

src/psc/gallery/authors/pauleveritt.md

@@ -0,0 +1,6 @@
+---
+title: Paul Everitt
+---
+
+Python and Web Developer Advocate at @JetBrains for @PyCharm and @WebStormIDE.
+Python oldster, Zope/Plone/Pyramid mafia. Girls lacrosse, formerly running.

src/psc/resources.py

@@ -17,13 +17,12 @@
 from psc.here import HERE
 from psc.here import PYODIDE
 
-
 EXCLUSIONS = ("pyscript.css", "pyscript.js", "favicon.png")
 
 
 def tag_filter(
-    tag: Tag,
-    exclusions: tuple[str, ...] = EXCLUSIONS,
+        tag: Tag,
+        exclusions: tuple[str, ...] = EXCLUSIONS,
 ) -> bool:
     """Filter nodes from example that should not get included."""
     attr = "href" if tag.name == "link" else "src"
@@ -113,6 +112,19 @@ def __post_init__(self) -> None:
         self.body = get_body_content(soup)
 
 
+@dataclass
+class Author(Resource):
+    """Information about an author, from Markdown."""
+
+    def __post_init__(self) -> None:
+        """Initialize the rest of the fields from the Markdown."""
+        md_file = HERE / "gallery/authors" / f"{self.path}.md"
+        md_fm = frontmatter.load(md_file)
+        self.title = md_fm.get("title", "")
+        md = MarkdownIt()
+        self.body = str(md.render(md_fm.content))
+
+
 @dataclass
 class Page(Resource):
     """A Markdown+frontmatter driven content page."""
@@ -153,27 +165,39 @@ def __post_init__(self) -> None:
 class Resources:
     """Container for all resources in site."""
 
+    authors: dict[PurePath, Author] = field(default_factory=dict)
     examples: dict[PurePath, Example] = field(default_factory=dict)
     pages: dict[PurePath, Page] = field(default_factory=dict)
 
 
-def get_sorted_examples() -> list[PurePath]:
+def get_sorted_paths(target_dir: Path, only_dirs: bool = True) -> list[PurePath]:
     """Return an alphabetized listing of the examples."""
-    examples_dir = HERE / "gallery/examples"
-    examples = [e for e in examples_dir.iterdir() if e.is_dir()]
-    return sorted(examples, key=attrgetter("name"))
+    if only_dirs:
+        paths = [e for e in target_dir.iterdir() if e.is_dir()]
+    else:
+        paths = [e for e in target_dir.iterdir()]
+
+    return sorted(paths, key=attrgetter("name"))
 
 
 def get_resources() -> Resources:
     """Factory to construct all the resources in the site."""
     resources = Resources()
 
     # Load the examples
-    for example in get_sorted_examples():
+    examples = HERE / "gallery/examples"
+    for example in get_sorted_paths(examples):
         this_path = PurePath(example.name)
         this_example = Example(path=this_path)
         resources.examples[this_path] = this_example
 
+    # Load the authors
+    authors = HERE / "gallery/authors"
+    for author in get_sorted_paths(authors, only_dirs=False):
+        this_path = PurePath(author.stem)
+        this_author = Author(path=this_path)
+        resources.authors[this_path] = this_author
+
     # Load the Pages
     pages_dir = HERE / "pages"
     pages = [e for e in pages_dir.iterdir()]

tests/test_resources.py

@@ -5,16 +5,16 @@
 import pytest
 from bs4 import BeautifulSoup
 
-from psc.resources import Example
+from psc.here import HERE
+from psc.resources import Example, Resources
 from psc.resources import Page
 from psc.resources import get_body_content
 from psc.resources import get_head_nodes
 from psc.resources import get_resources
-from psc.resources import get_sorted_examples
+from psc.resources import get_sorted_paths
 from psc.resources import is_local
 from psc.resources import tag_filter
 
-
 IS_LOCAL = is_local()
 
 
@@ -30,6 +30,11 @@ def head_soup() -> BeautifulSoup:
     return BeautifulSoup(head, "html5lib")
 
 
+@pytest.fixture(scope="module")
+def resources() -> Resources:
+    return get_resources()
+
+
 def test_tag_filter(head_soup: BeautifulSoup) -> None:
     """Helper function to filter link and script from head."""
     excluded_link = head_soup.select("link")[0]
@@ -118,8 +123,8 @@ def test_example() -> None:
     this_example = Example(path=PurePath("hello_world"))
     assert this_example.title == "Hello World"
     assert (
-        this_example.subtitle
-        == "The classic hello world, but in Python -- in a browser!"
+            this_example.subtitle
+            == "The classic hello world, but in Python -- in a browser!"
     )
     assert "hello_world.css" in this_example.extra_head
     assert "<h1>Hello ...</h1>" in this_example.body
@@ -155,23 +160,29 @@ def test_missing_page() -> None:
 
 
 def test_sorted_examples() -> None:
-    """Ensure a stable listing."""
-    examples = get_sorted_examples()
+    """Ensure a stable listing of dirs."""
+    examples = get_sorted_paths(HERE / "gallery/examples")
     first_example = examples[0]
     assert "altair" == first_example.name
 
 
-def test_get_resources() -> None:
+def test_sorted_authors() -> None:
+    """Ensure a stable listing of files."""
+    authors = get_sorted_paths(HERE / "gallery/authors", only_dirs=False)
+    first_author = authors[0]
+    assert "meg-1.md" == first_author.name
+
+
+def test_get_resources(resources: Resources) -> None:
     """Ensure the dict-of-dicts is generated with PurePath keys."""
-    resources = get_resources()
 
     # Example
     hello_world_path = PurePath("hello_world")
     hello_world = resources.examples[hello_world_path]
     assert hello_world.title == "Hello World"
     assert (
-        hello_world.subtitle
-        == "The classic hello world, but in Python -- in a browser!"
+            hello_world.subtitle
+            == "The classic hello world, but in Python -- in a browser!"
     )
 
     # Page
@@ -186,3 +197,10 @@ def test_is_local_broken_path() -> None:
     test_path = Path("/xxx")
     actual = is_local(test_path)
     assert not actual
+
+
+def test_authors(resources: Resources) -> None:
+    """Get the list of authors as defined in Markdown files."""
+    authors = resources.authors
+    first_author = list(authors.values())[0]
+    assert "meg-1" == first_author.path.name