use toml and pydantic

Author: honzajavorek

CONTRIBUTING.rst

@@ -43,7 +43,7 @@ Slack
 
 Při psaní lze psát ``:slack:`#pyladies`` nebo i jenom ``:slack:`pyladies``, což vytvoří odkaz na kanál :slack:`#pyladies` na Pyvec Slacku. Funguje to díky vlastnímu rozšíření Sphinxu, které lze najít v souboru ``_extensions/slack.py``.
 
-Všechny odkazy na kanál ``:slack:`#pyvec-board``, ať už je to ``:slack:`#pyvec-board`` nebo ``:slack:`#pyvec-board-2019-2021`` jsou automaticky předělány na odkaz na aktuální tajný kanál výboru. K určení správných roků se využívá `soubor board.yml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/board.yml>`_.
+Všechny odkazy na kanál ``:slack:`#pyvec-board``, ať už je to ``:slack:`#pyvec-board`` nebo ``:slack:`#pyvec-board-2019-2021`` jsou automaticky předělány na odkaz na aktuální tajný kanál výboru. K určení správných roků se využívá `soubor boards.toml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/boards.toml>`_.
 
 .. _docs-pyvec-rtd:
 
@@ -98,7 +98,7 @@ Skript na generování historie výborů
 V adresáři ``scripts`` je skript ``generate_boards.py``, který:
 
 * se pomocí `GitHub Actions <https://github.com/pyvec/docs.pyvec.org/actions>`_ jednou denně spustí,
-* vygeneruje soubor ``operations/boards.rst`` ze `souboru board.yml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/board.yml>`_ a ze šablony ``operations/boards.rst``,
+* vygeneruje soubor ``operations/boards.rst`` ze `souboru boards.toml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/boards.toml>`_ a ze šablony ``operations/boards.rst``,
 * commitne a pushne jej přes Git do repozitáře.
 
 Výsledná stránka je pouze informační, kanonickým zdrojem pravdy jsou v tomto případě státní registry.
@@ -114,4 +114,4 @@ V adresáři ``scripts`` je skript ``generate_grants.py``, který:
 * vygeneruje soubor ``operations/grants.rst`` z dat na `pyvec/money <https://github.com/pyvec/money>`_ a ze šablony ``operations/grants.rst``,
 * commitne a pushne jej přes Git do repozitáře.
 
-Hlasování o grantech probíhá :ref:`pomocí reakcí <jak-hlasovani>` na GitHub Issues a tento skript hlasování archivuje sem do dokumentace pro účely jednoduššího vyhledávání, zálohy, kdyby se s `pyvec/money <https://github.com/pyvec/money>`_ něco stalo, a pro nějakou historickou evidenci. Kanonickým zdrojem pravdy ale zůstává hlasování přímo na GitHub Issues, toto je jen automatizovaný přepis. Skript započítává pouze hlasy od členů výboru (podle `souboru board.yml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/board.yml>`_).
+Hlasování o grantech probíhá :ref:`pomocí reakcí <jak-hlasovani>` na GitHub Issues a tento skript hlasování archivuje sem do dokumentace pro účely jednoduššího vyhledávání, zálohy, kdyby se s `pyvec/money <https://github.com/pyvec/money>`_ něco stalo, a pro nějakou historickou evidenci. Kanonickým zdrojem pravdy ale zůstává hlasování přímo na GitHub Issues, toto je jen automatizovaný přepis. Skript započítává pouze hlasy od členů výboru (podle `souboru boards.toml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/boards.toml>`_).

docs/operations/boards.rst

@@ -1,7 +1,7 @@
 Výbory spolku
 =============
 
-Historie složení :term:`výboru <Výbor>`. Kanonickým zdrojem pravdy je `výpis na justice.cz <https://or.justice.cz/ias/ui/rejstrik-firma.vysledky?subjektId=760829&typ=UPLNY>`_. Historii výborů si pro vlastní potřeby zaznamenáváme do `souboru board.yml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/board.yml>`_ a z něj se generuje i tato stránka.
+Historie složení :term:`výboru <Výbor>`. Kanonickým zdrojem pravdy je `výpis na justice.cz <https://or.justice.cz/ias/ui/rejstrik-firma.vysledky?subjektId=760829&typ=UPLNY>`_. Historii výborů si pro vlastní potřeby zaznamenáváme do `souboru boards.toml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/boards.toml>`_ a z něj se generuje i tato stránka.
 
 Kdyby něco nesedělo, ověřte `historii zdrojáku této stránky <https://github.com/pyvec/docs.pyvec.org/commits/master/operations/boards.rst>`_ a funkčnost :ref:`přepisů <generate_boards>`.
 
@@ -15,10 +15,10 @@ Mandát od 9.4.2022
    :header: "Jméno", "GitHub", "Funkce"
 
    Barbora Drbohlavová, `@baradrb <https://github.com/baradrb>`_, |:crown:|
-   Anežka Müller, `@anezkamll <https://github.com/anezkamll>`_, 
-   Jan Javorek, `@honzajavorek <https://github.com/honzajavorek>`_, 
-   Jakub Vysoký, `@kvbik <https://github.com/kvbik>`_, 
-   Jan Čermák, `@sairon <https://github.com/sairon>`_, 
+   Anežka Müller, `@anezkamll <https://github.com/anezkamll>`_,
+   Jan Javorek, `@honzajavorek <https://github.com/honzajavorek>`_,
+   Jakub Vysoký, `@kvbik <https://github.com/kvbik>`_,
+   Jan Čermák, `@sairon <https://github.com/sairon>`_,
 
 Mandát od 8.4.2019
 -------------------------------------------------
@@ -27,10 +27,10 @@ Mandát od 8.4.2019
    :header: "Jméno", "GitHub", "Funkce"
 
    Martin Bílek, `@martinbilek <https://github.com/martinbilek>`_, |:crown:|
-   Aleš Zoulek, `@aleszoulek <https://github.com/aleszoulek>`_, 
-   Jan Javorek, `@honzajavorek <https://github.com/honzajavorek>`_, 
-   Jakub Vysoký, `@kvbik <https://github.com/kvbik>`_, 
-   Jiří Bartoň, `@whiskybar <https://github.com/whiskybar>`_, 
+   Aleš Zoulek, `@aleszoulek <https://github.com/aleszoulek>`_,
+   Jan Javorek, `@honzajavorek <https://github.com/honzajavorek>`_,
+   Jakub Vysoký, `@kvbik <https://github.com/kvbik>`_,
+   Jiří Bartoň, `@whiskybar <https://github.com/whiskybar>`_,
 
 Mandát od 27.3.2012
 -------------------------------------------------
@@ -39,10 +39,10 @@ Mandát od 27.3.2012
    :header: "Jméno", "GitHub", "Funkce"
 
    Martin Bílek, `@martinbilek <https://github.com/martinbilek>`_, |:crown:|
-   Aleš Zoulek, `@aleszoulek <https://github.com/aleszoulek>`_, 
-   Robin Gottfried, `@czervenka <https://github.com/czervenka>`_, 
-   Jan Král, `@honzakral <https://github.com/honzakral>`_, 
-   Jakub Vysoký, `@kvbik <https://github.com/kvbik>`_, 
-   Jiří Bartoň, `@whiskybar <https://github.com/whiskybar>`_, 
-   Vítězslav Pliska, `@whit <https://github.com/whit>`_, 
+   Aleš Zoulek, `@aleszoulek <https://github.com/aleszoulek>`_,
+   Robin Gottfried, `@czervenka <https://github.com/czervenka>`_,
+   Jan Král, `@honzakral <https://github.com/honzakral>`_,
+   Jakub Vysoký, `@kvbik <https://github.com/kvbik>`_,
+   Jiří Bartoň, `@whiskybar <https://github.com/whiskybar>`_,
+   Vítězslav Pliska, `@whit <https://github.com/whit>`_,
 

docs/operations/boards.rst.jinja

@@ -1,7 +1,7 @@
 Výbory spolku
 =============
 
-Historie složení :term:`výboru <Výbor>`. Kanonickým zdrojem pravdy je `výpis na justice.cz <https://or.justice.cz/ias/ui/rejstrik-firma.vysledky?subjektId=760829&typ=UPLNY>`_. Historii výborů si pro vlastní potřeby zaznamenáváme do `souboru board.yml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/board.yml>`_ a z něj se generuje i tato stránka.
+Historie složení :term:`výboru <Výbor>`. Kanonickým zdrojem pravdy je `výpis na justice.cz <https://or.justice.cz/ias/ui/rejstrik-firma.vysledky?subjektId=760829&typ=UPLNY>`_. Historii výborů si pro vlastní potřeby zaznamenáváme do `souboru boards.toml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/boards.toml>`_ a z něj se generuje i tato stránka.
 
 Kdyby něco nesedělo, ověřte `historii zdrojáku této stránky <https://github.com/pyvec/docs.pyvec.org/commits/master/operations/boards.rst>`_ a funkčnost :ref:`přepisů <generate_boards>`.
 

docs/operations/elections.rst

@@ -62,7 +62,7 @@ Předání moci
 - Nový výbor oznámí své zvolení v :slack:`#announcements`.
 - Starý výbor zajistí vyhotovení zápisů ze zasedání členské schůze a z předání moci:
     - Vyhotoví :ref:`zápisy do této dokumentace <zapisy>`,
-    - aktualizuje `soubor board.yml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/board.yml>`_,
+    - aktualizuje `soubor boards.toml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/boards.toml>`_,
     - aktualizuje role členů v `seznamu členů <https://docs.google.com/spreadsheets/d/1n8hzBnwZ5ANkUCvwEy8rWsXlqeAAwu-5JBodT5OJx_I/edit#gid=0>`__, čímž by se měl aktualizovat i web Pyvce
 - Starý výbor předá novému vše ze seznamu níže.
 

pyproject.toml

@@ -5,11 +5,11 @@ requires-python = "==3.12.*"
 dependencies = [
     "jinja2==3.1.6",
     "myst-parser==4.0.1",
+    "pydantic==2.11.4",
     "requests==2.32.3",
     "sphinx-rtd-theme==3.0.2",
     "sphinx==8.2.3",
     "sphinxemoji==0.3.1",
-    "strictyaml==1.7.3",
 ]
 
 [dependency-groups]
@@ -26,10 +26,6 @@ build-backend = "uv_build"
 [tool.pytest.ini_options]
 testpaths = "tests"
 addopts = "--ff --ruff --ruff-format"
-norecursedirs = "_build _static _templates"
-
-[tool.ruff]
-target-version = "py312"
 
 [tool.ruff.lint]
 extend-select = ["I"]

scripts/generate_boards.py

@@ -2,7 +2,7 @@
 
 from jinja2 import Template
 
-from pyvec_docs.board import BOARD_HISTORY
+from pyvec_docs.board import load_boards
 
 
 CONTENT_PATH = Path(__file__).parent.parent / "docs"
@@ -11,4 +11,4 @@
 if __name__ == "__main__":
     tpl_path = CONTENT_PATH / "operations" / "boards.rst.jinja"
     tpl = Template(tpl_path.read_text())
-    print(tpl.render(boards=BOARD_HISTORY))
+    print(tpl.render(boards=load_boards()))

scripts/generate_grants.py

@@ -5,7 +5,7 @@
 import requests
 from jinja2 import Template
 
-from pyvec_docs.board import BOARD_HISTORY
+from pyvec_docs.board import load_boards
 from pyvec_docs.grants import get_lock_date, get_votes, remove_comments, to_date
 
 
@@ -19,6 +19,8 @@
 
 
 if __name__ == "__main__":
+    boards = load_boards()
+
     res = requests.get(
         GITHUB_API_URL,
         headers=GITHUB_API_HEADERS,
@@ -54,7 +56,7 @@
 
         res = requests.get(issue["reactions"]["url"], headers=GITHUB_API_HEADERS)
         res.raise_for_status()
-        votes = list(get_votes(res.json(), voted_at, BOARD_HISTORY))
+        votes = list(get_votes(res.json(), voted_at, boards))
 
         grants.append(
             {

src/pyvec_docs/board.py

@@ -1,20 +1,48 @@
-from operator import itemgetter
+import tomllib
+from datetime import date
+from enum import StrEnum
+from functools import cache
+from operator import attrgetter
 from pathlib import Path
 
-import strictyaml as yaml
+from pydantic import BaseModel
 
 
-BOARD_HISTORY_SCHEMA = yaml.Seq(
-    yaml.Map(
-        {
-            "from": yaml.Datetime(),
-            "members": yaml.MapPattern(yaml.Str(), yaml.Str()),
-        }
+BOARDS_CONFIG_PATH = Path(__file__).parent / "boards.toml"
+
+BOARDS_MANDATE_LENGTH = 3
+
+
+class BoardRole(StrEnum):
+    chair = "chair"
+    treasurer = "treasurer"
+
+
+class BoardMember(BaseModel):
+    name: str
+    github: str
+    roles: set[BoardRole] | None = set()
+
+    model_config = {"extra": "forbid", "frozen": True}
+
+
+class Board(BaseModel):
+    start_on: date
+    members: list[BoardMember]
+
+    model_config = {"extra": "forbid", "frozen": True}
+
+    @property
+    def years(self) -> tuple[int, int]:
+        start_year = self.start_on.year
+        return (start_year, start_year + BOARDS_MANDATE_LENGTH)
+
+
+@cache
+def load_boards(path: Path | str = BOARDS_CONFIG_PATH) -> list[Board]:
+    data = tomllib.loads(Path(path).read_text())
+    return sorted(
+        (Board(**board) for board in data["boards"]),
+        key=attrgetter("start_on"),
+        reverse=True,
     )
-)
-BOARD_HISTORY_PATH = Path(__file__).parent / "board.yml"
-BOARD_HISTORY = sorted(
-    yaml.load(BOARD_HISTORY_PATH.read_text(), BOARD_HISTORY_SCHEMA).data,
-    key=itemgetter("from"),
-    reverse=True,
-)

src/pyvec_docs/board.yml

@@ -0,0 +1,88 @@
+# The Pyvec board members in time
+# The current board is first, previous boards are listed in descending order
+# Each member has a `name`, `github`, and optionally a `roles` array
+
+[[board]]
+start_on = "2022-04-09"
+
+[[board.members]]
+name = "Barbora Drbohlavová"
+github = "baradrb"
+roles = ["chair"]
+
+[[board.members]]
+name = "Anežka Müller"
+github = "anezkamll"
+
+[[board.members]]
+name = "Jan Javorek"
+github = "honzajavorek"
+
+[[board.members]]
+name = "Jakub Vysoký"
+github = "kvbik"
+
+[[board.members]]
+name = "Jan Čermák"
+github = "sairon"
+roles = ["treasurer"]
+
+
+
+[[board]]
+start_on = "2019-04-08"
+
+[[board.members]]
+name = "Martin Bílek"
+github = "martinbilek"
+roles = ["chair", "treasurer"]
+
+[[board.members]]
+name = "Aleš Zoulek"
+github = "aleszoulek"
+
+[[board.members]]
+name = "Jan Javorek"
+github = "honzajavorek"
+
+[[board.members]]
+name = "Jakub Vysoký"
+github = "kvbik"
+
+[[board.members]]
+name = "Jiří Bartoň"
+github = "whiskybar"
+
+
+
+[[board]]
+start_on = "2012-03-27"
+
+[[board.members]]
+name = "Martin Bílek"
+github = "martinbilek"
+roles = ["chair", "treasurer"]
+
+[[board.members]]
+name = "Aleš Zoulek"
+github = "aleszoulek"
+
+[[board.members]]
+name = "Robin Gottfried"
+github = "czervenka"
+
+[[board.members]]
+name = "Jan Král"
+github = "honzakral"
+
+[[board.members]]
+name = "Jakub Vysoký"
+github = "kvbik"
+
+[[board.members]]
+name = "Jiří Bartoň"
+github = "whiskybar"
+
+[[board.members]]
+name = "Vítězslav Pliska"
+github = "whit"