quizzy 0.1.0__py3-none-any.whl

quizzy/__init__.py

@@ -0,0 +1,3 @@
+import importlib.metadata
+
+__version__ = importlib.metadata.version(__name__)

quizzy/__main__.py

@@ -0,0 +1,9 @@
+from quizzy.app import QuizzyApp
+
+
+def main() -> None:
+    QuizzyApp().run()
+
+
+if __name__ == "__main__":
+    main()

quizzy/app.py

@@ -0,0 +1,208 @@
+from __future__ import annotations
+
+import argparse
+import pathlib
+
+from textual import app, containers, log, message, reactive, screen, widgets
+
+from quizzy import __version__, models
+
+
+def get_arg_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(prog=__name__.split(".")[0], description="A terminal quiz app")
+    parser.add_argument("--version", action="version", version=f"%(prog)s {__version__}")
+    parser.add_argument("quizfile", type=pathlib.Path, help="Quiz file")
+    return parser
+
+
+class AnswerScreen(screen.ModalScreen[models.Team | None]):
+    NOONE_ANSWERED_ID = "__noone-answered"
+
+    def __init__(self, category: str, question: models.Question, teams: list[models.Team]) -> None:
+        super().__init__(classes="question-answer-screen")
+        self.category = category
+        self.question = question
+        self.teams = {team.id: team for team in teams}
+        self.border_title = f"{category} - {question.value} points"
+
+    def compose(self) -> app.ComposeResult:
+        question_widget = widgets.Static(self.question.question, id="question")
+        question_widget.border_title = "Question"
+
+        answer_widget = widgets.Static(self.question.answer, id="answer")
+        answer_widget.border_title = "Answer"
+
+        whoanswered = containers.HorizontalGroup(
+            *[
+                containers.Vertical(widgets.Button(team.name, id=team_id, variant="primary"))
+                for team_id, team in self.teams.items()
+            ],
+            id="who-answered",
+            classes="horizontal-100",
+        )
+        whoanswered.border_title = "Who Answered Correctly?"
+
+        container = containers.Grid(
+            question_widget,
+            answer_widget,
+            whoanswered,
+            containers.Horizontal(
+                widgets.Button(
+                    "😭 No one answered correctly 😭", id=self.NOONE_ANSWERED_ID, variant="error", classes="button-100"
+                ),
+                classes="horizontal-100",
+            ),
+            classes="question-answer-dialog",
+            id="dialog",
+        )
+
+        container.border_title = f"{self.category} - {self.question.value} points"
+        yield container
+
+    def on_button_pressed(self, event: widgets.Button.Pressed) -> None:
+        if event.button.id == self.NOONE_ANSWERED_ID:
+            self.dismiss(None)
+        elif event.button.id in self.teams:
+            team = self.teams[event.button.id]
+            self.dismiss(team)
+
+
+class QuestionScreen(screen.ModalScreen[models.Team | None]):
+    SHOW_ANSWER_ID = "show-answer"
+
+    def __init__(self, category: str, question: models.Question, teams: list[models.Team]) -> None:
+        super().__init__(classes="question-answer-screen")
+        self.category = category
+        self.question = question
+        self.teams = teams
+
+    def compose(self) -> app.ComposeResult:
+        question_widget = widgets.Static(self.question.question, id="question")
+        question_widget.border_title = "Question"
+
+        container = containers.Grid(
+            question_widget,
+            containers.Horizontal(
+                widgets.Button("Show Answer", id=self.SHOW_ANSWER_ID, variant="primary", classes="button-100"),
+                classes="horizontal-100",
+            ),
+            classes="question-answer-dialog",
+            id="dialog",
+        )
+
+        container.border_title = f"{self.category} - {self.question.value} points"
+        yield container
+
+    def on_button_pressed(self, event: widgets.Button.Pressed) -> None:
+        def dismiss(team: models.Team | None) -> None:
+            self.dismiss(team)
+
+        if event.button.id == self.SHOW_ANSWER_ID:
+            self.app.push_screen(AnswerScreen(self.category, self.question, self.teams), dismiss)
+
+
+class TeamScore(containers.Vertical):
+    score = reactive.reactive(0, recompose=True)
+
+    def __init__(self, team: models.Team) -> None:
+        self.team = team
+        super().__init__()
+        self.border_title = self.team.name
+        self.score = team.score
+
+    def compose(self) -> app.ComposeResult:
+        yield widgets.Static(str(self.score))
+
+    def watch_score(self, score: int) -> None:
+        """
+        Watch the reactive score and update the team's score in the data object. This allows dumping the quiz state
+        to YAML.
+        """
+        self.team.score = score
+
+
+class Scoreboard(containers.Vertical):
+    def __init__(self, teams: list[models.Team]) -> None:
+        super().__init__()
+        self.teams = teams
+        self.team_score_widgets = {team.id: TeamScore(team) for team in teams}
+
+    def compose(self) -> app.ComposeResult:
+        yield containers.HorizontalGroup(*self.team_score_widgets.values())
+
+    def update_team_score(self, team_id: str, value: int) -> None:
+        log(f"scoreboard: Updating team score {team_id} to {value}")
+        self.team_score_widgets[team_id].score += value
+
+
+class QuestionButton(widgets.Button):
+    class Answered(message.Message):
+        def __init__(self, team: models.Team, question_value: int) -> None:
+            self.team = team
+            self.value = question_value
+            super().__init__()
+
+    def __init__(self, category: str, question: models.Question, teams: list[models.Team]) -> None:
+        self.question = question
+        self.teams = teams
+        self.category = category
+        super().__init__(str(question.value), variant="warning", classes="button-100")
+        # Disable the button if the question has already been answered on init. This might be useful when starting with
+        # a state
+        self.disabled = question.answered
+
+    def on_click(self) -> None:
+        # First, disable the button to prevent multiple clicks
+        self.disabled = True
+        self.question.answered = True
+
+        def wait_for_result(team: models.Team | None) -> None:
+            if team is None:
+                log("question-button: No-one answered the question")
+            else:
+                log(f"question-button: {team.id} answered the question")
+                self.post_message(self.Answered(team, self.question.value))
+
+        self.app.push_screen(QuestionScreen(self.category, self.question, self.teams), wait_for_result)
+
+
+class CategoryColumn(containers.VerticalGroup):
+    def __init__(self, category: models.Category, teams: list[models.Team]) -> None:
+        self.category = category
+        self.teams = teams
+        super().__init__()
+
+    def compose(self) -> app.ComposeResult:
+        yield widgets.Static(self.category.name)
+        for question in self.category.questions:
+            yield QuestionButton(self.category.name, question, self.teams)
+
+
+class QuestionBoard(containers.HorizontalGroup):
+    def __init__(self, config: models.Config) -> None:
+        self.config = config
+        super().__init__()
+
+    def compose(self) -> app.ComposeResult:
+        for category in self.config.categories:
+            yield CategoryColumn(category, self.config.teams)
+
+
+class QuizzyApp(app.App[None]):
+    CSS_PATH = "quizzy.tcss"
+
+    def __init__(self) -> None:
+        super().__init__()
+        parser = get_arg_parser()
+        namespace = parser.parse_args()
+
+        self.config = models.load_config(namespace.quizfile)
+        self.scoreboard_widget = Scoreboard(self.config.teams)
+
+    def compose(self) -> app.ComposeResult:
+        yield widgets.Header()
+        yield widgets.Footer()
+        yield containers.Grid(QuestionBoard(self.config), self.scoreboard_widget, id="app-grid")
+
+    def on_question_button_answered(self, event: QuestionButton.Answered) -> None:
+        self.scoreboard_widget.update_team_score(event.team.id, event.value)

quizzy/models.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+import pathlib
+from typing import Self
+
+import yaml
+from pydantic import Field, model_validator
+from pydantic.dataclasses import dataclass
+
+
+@dataclass
+class Team:
+    name: str = Field(min_length=2)
+    score: int = Field(default=0, ge=0)
+    id: str = Field(init=False)
+
+    def __post_init__(self) -> None:
+        self.id = self.name.replace(" ", "-").lower()
+
+    def __str__(self) -> str:
+        return self.name
+
+
+@dataclass
+class Question:
+    question: str
+    answer: str
+    value: int = Field(gt=0)
+    answered: bool = False
+
+    def __str__(self) -> str:
+        return self.question
+
+
+@dataclass
+class Category:
+    name: str
+    questions: list[Question] = Field(max_length=5)
+
+    @model_validator(mode="after")
+    def sort_questions(self) -> Self:
+        """Sort the questions in this category by their value."""
+
+        self.questions.sort(key=lambda q: q.value)
+        return self
+
+
+@dataclass
+class Config:
+    categories: list[Category] = Field(max_length=5)
+    teams: list[Team] = Field(default=[Team("Team 1"), Team("Team 2")])
+    # TODO: Support random questions
+
+
+def load_config(path: pathlib.Path) -> Config:
+    with path.open() as f:
+        raw = yaml.safe_load(f)
+
+    return Config(**raw)

quizzy/quizzy.tcss

@@ -0,0 +1,101 @@
+TeamScore {
+  border: solid $primary;
+  align: center top;
+  height: 3;
+  margin: 1;
+}
+
+
+.question-answer-screen {
+  align: center middle;
+}
+
+.question-answer-dialog {
+  width: 80%;
+  height: 80%;
+  min-height: 40;
+  padding: 0 2;
+  border: solid $primary;
+  background: $surface;
+  content-align: center middle;
+
+  #question {
+    content-align: center middle;
+    padding: 2;
+    border: solid $foreground 80%;
+  }
+
+  #answer {
+    content-align: center middle;
+    padding: 2;
+    border: solid $success 80%;
+
+  }
+}
+
+QuestionScreen {
+  #dialog {
+    grid-size: 1;
+    grid-rows: 90% 6;
+  }
+}
+
+.horizontal-100 {
+  width: 100%;
+}
+
+Button.button-100 {
+  width: 100%;
+
+  &:focus {
+    /* Disable reversing for text of focussed full-width buttons */
+    text-style: bold;
+  }
+}
+
+AnswerScreen {
+  #dialog {
+    grid-size: 1;
+    grid-rows: 40% 40% 5 4;
+
+    #who-answered {
+      border: solid $foreground 80%;
+      Button {
+        margin: 0 1;
+        width: 100%;
+        &:focus {
+          /* Disable reversing for text of focussed buttons in the who-answered row */
+          text-style: bold;
+        }
+      }
+    }
+  }
+
+}
+
+QuestionBoard {
+  width: 100%;
+  padding: 5 0  0 0;
+  min-width: 50%;
+  align: center top;
+}
+
+CategoryColumn {
+  width: auto;
+  min-width: 30;
+  border: solid $secondary;
+  align: center middle;
+
+  Button {
+    margin: 1;
+
+    &:disabled {
+      opacity: 0.5;
+    }
+  }
+}
+
+#app-grid {
+  grid-size: 1 2;
+  grid-rows: 1fr 5;
+}

quizzy-0.1.0.dist-info/METADATA

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: quizzy
+Version: 0.1.0
+Summary: A Python TUI quiz app
+Author-email: Jonas Ehrlich <jonas.ehrlich@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: pydantic>=2.10.3
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: textual>=1.0.0
+Description-Content-Type: text/markdown
+
+# Quizzy
+
+A quiz app using [textual](https://textual.textualize.io/).
+
+![Question board](assets/question-board.png)
+
+
+## Configuration and Questions
+
+Create a YAML file to define the teams participating, the questions and their answers.
+
+```yaml
+teams:
+  - name: "Team 1"
+  - name: "Team 2"
+categories:
+  - name: "General Knowledge"
+    questions:
+      - question: "What is the capital of France?"
+        answer: "Paris"
+        value: 100
+      - question: "What is the capital of Germany?"
+        answer: "Berlin"
+        value: 200
+  - name: "Science"
+    questions:
+      - question: "What is the chemical symbol for gold?"
+        answer: "Au"
+        value: 100
+      - question: "What is the chemical symbol for silver?"
+        answer: "Ag"
+        value: 200
+```
+
+See [examples/quizzy.yaml](examples/quizzy.yaml) for an example.
+
+
+## Running it
+
+Run normally using *uv*:
+
+``` sh
+uv run quizzy examples/quizzy.yaml
+```
+
+Serve using textual:
+
+``` sh
+uv run textual serve "uv run quizzy examples/quizzy.yaml"
+```
+
+Run in development mode:
+
+``` sh
+uv run textual run --dev quizzy.app:QuizzyApp examples/quizzy.yaml
+```

quizzy-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+quizzy/__init__.py,sha256=IILIKzO2OO60Rhsh3SqhdKHDf7XI_RLRwzztBGZZmHY,78
+quizzy/__main__.py,sha256=TxTz5dT__4--aF49xzShPppphmYLCNYKMraPhp6scIc,117
+quizzy/app.py,sha256=B9fIHy9L5HILbuDoY4ief0wCcVY8_X9Uqb0ByK_ihQk,7687
+quizzy/models.py,sha256=JrAc2IvtXByIKNg_lX7uQMK19zwi2WsYcNbttXccbOs,1265
+quizzy/quizzy.tcss,sha256=ixFfm8pT_JLdL0XZ-4n8u0fs3l9lAHWQa3-q9d4bRRU,1455
+quizzy-0.1.0.dist-info/METADATA,sha256=l3qoY9aRtg1Cpx-QvLHckMP7LmpjsviO9qg15o0oeT4,1464
+quizzy-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+quizzy-0.1.0.dist-info/entry_points.txt,sha256=2RiVMgcS4h7TM59u9dyBQFm53cG6Eyekmb8fqZ5rXHM,48
+quizzy-0.1.0.dist-info/licenses/LICENSE,sha256=JWN3MACgsucm6y_rlL_2MUzst0-wNh-Wab3XkxtfVzM,1070
+quizzy-0.1.0.dist-info/RECORD,,

quizzy-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

quizzy-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+quizzy = quizzy.__main__:main

quizzy-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jonas Ehrlich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.