main.py

from pathlib import Path
from typing import Literal

import yaml
from pydantic import BaseModel

PLATFORM = Literal["zulip", "email", "github", "linkedin"]
DATA_FOLDER = Path("data")
ROLE = Literal[
    "steering", "moderator", "project-parcels", "project-opendrift", "project-trajan"
]


def get_social_icon(platform: PLATFORM) -> str:
    icons = {
        "zulip": "fa-brands fa-zulip",
        "email": "fa-solid fa-envelope",
        "github": "fa-brands fa-github",
        "linkedin": "fa-brands fa-linkedin",
    }
    return icons.get(platform, "fa-solid fa-user")


def get_platform_display_name(platform: PLATFORM) -> str:
    display_names = {
        "zulip": "Zulip",
        "email": "Email",
        "github": "GitHub",
        "linkedin": "LinkedIn",
    }
    return display_names.get(platform, platform.capitalize())


class SocialAccount(BaseModel):
    platform: PLATFORM
    url: str

    def get_markdown(self) -> str:
        return f"[{get_platform_display_name(self.platform)}]({self.url})"


class Person(BaseModel):
    name: str
    roles: list[ROLE]
    socials: list[SocialAccount]
    preferred_method_of_contact: str

    def to_card(self) -> str:
        return f"""   - ![Profile picture]({get_profile_picture_url(self.socials)}){{width=200px}}

    **{self.name}**

    ---

    {" | ".join(social.get_markdown() for social in self.socials)}

    _Preferred contact: {self.preferred_method_of_contact}_
    """


def get_profile_picture_url(socials: list[SocialAccount]) -> str:
    for social in socials:
        if social.platform == "github":
            return social.url.rstrip("/") + ".png"
    return "./assets/default-profile-pic.png"


def render_people_to_grid(people: list[Person]) -> str:
    cards = "\n".join(person.to_card() for person in people)
    return f'<div class="grid cards" markdown>\n\n{cards}\n\n</div>'


def get_people() -> list[Person]:
    people_yaml_path = DATA_FOLDER / "people.yaml"
    with open(people_yaml_path) as f:
        people_data = yaml.safe_load(f)
    return [Person(**person) for person in people_data["person"]]


PEOPLE = sorted(
    get_people(), key=lambda person: person.name.split()[0]
)  # Sort by first name


def define_env(env):
    """Mkdocs hook for the variables, macros and filters."""

    @env.macro
    def render_role_grid(role: ROLE) -> str:
        """Render people with their roles"""
        return render_people_to_grid(
            [person for person in PEOPLE if role in person.roles]
        )