quizzy 0.1.0__tar.gz → 0.3.0__tar.gz

{quizzy-0.1.0 → quizzy-0.3.0}/.pre-commit-config.yaml

@@ -5,15 +5,13 @@ repos:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  - repo: https://github.com/psf/black
-    rev: "24.10.0"
-    hooks:
-      - id: black
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     # Ruff version.
     rev: "v0.8.3"
     hooks:
-      - id: ruff
+    - id: ruff
+      args: [ --fix ]
+    - id: ruff-format
   - repo: https://github.com/pycqa/isort
     rev: "5.13.2"
     hooks:

quizzy-0.3.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## v0.3.0
+
+* Add *Escape* keybinding to dismiss question and answer modals
+* Add score modifier buttons
+
+## v0.2.0
+
+* Added support for Markdown syntax in questions and answers
+
+## v0.1.0
+
+* Initial release with basic functionality

{quizzy-0.1.0 → quizzy-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: quizzy
-Version: 0.1.0
+Version: 0.3.0
 Summary: A Python TUI quiz app
 Author-email: Jonas Ehrlich <jonas.ehrlich@gmail.com>
 License-Expression: MIT
@@ -17,7 +17,6 @@ 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.
@@ -47,16 +46,21 @@ categories:
 
 See [examples/quizzy.yaml](examples/quizzy.yaml) for an example.
 
-
 ## Running it
 
-Run normally using *uv*:
+Run the latest PyPI release using *uvx*:
+
+```sh
+uvx quizzy projects/gh/quizzy/examples/quizzy.yaml
+```
+
+Run the local version using *uv*:
 
 ``` sh
 uv run quizzy examples/quizzy.yaml
 ```
 
-Serve using textual:
+Serve on a webserver using textual:
 
 ``` sh
 uv run textual serve "uv run quizzy examples/quizzy.yaml"

{quizzy-0.1.0 → quizzy-0.3.0}/README.md

@@ -4,7 +4,6 @@ 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.
@@ -34,16 +33,21 @@ categories:
 
 See [examples/quizzy.yaml](examples/quizzy.yaml) for an example.
 
-
 ## Running it
 
-Run normally using *uv*:
+Run the latest PyPI release using *uvx*:
+
+```sh
+uvx quizzy projects/gh/quizzy/examples/quizzy.yaml
+```
+
+Run the local version using *uv*:
 
 ``` sh
 uv run quizzy examples/quizzy.yaml
 ```
 
-Serve using textual:
+Serve on a webserver using textual:
 
 ``` sh
 uv run textual serve "uv run quizzy examples/quizzy.yaml"

quizzy-0.3.0/examples/quizzy.yaml

@@ -0,0 +1,24 @@
+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](https://duckduckgo.com/?t=ffab&q=gold)?"
+        answer: "Au"
+        value: 100
+      - question: |
+          What is the chemical symbol for silver?
+
+          - We really need to know this one. And don't care about platinum which is Pt.
+          - Also not Helium which is He.
+        answer: "[Ag](https://en.wikipedia.org/wiki/Gold), that was easy **right**?"
+        value: 200

{quizzy-0.1.0 → quizzy-0.3.0}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "quizzy"
-version = "0.1.0"
+version = "0.3.0"
 description = "A Python TUI quiz app"
 authors = [{ name = "Jonas Ehrlich", email = "jonas.ehrlich@gmail.com" }]
 readme = "README.md"

{quizzy-0.1.0 → quizzy-0.3.0}/quizzy/app.py

@@ -3,10 +3,13 @@ from __future__ import annotations
 import argparse
 import pathlib
 
-from textual import app, containers, log, message, reactive, screen, widgets
+from textual import app, binding, containers, log, message, reactive, screen, widgets
 
 from quizzy import __version__, models
 
+NoCorrectAnswerType = type("NoCorrectAnswerType", (object,), {})
+NoCorrectAnswer = NoCorrectAnswerType()
+
 
 def get_arg_parser() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(prog=__name__.split(".")[0], description="A terminal quiz app")
@@ -15,9 +18,16 @@ def get_arg_parser() -> argparse.ArgumentParser:
     return parser
 
 
-class AnswerScreen(screen.ModalScreen[models.Team | None]):
+QuestionScreenResult = models.Team | NoCorrectAnswerType | None
+
+
+class AnswerScreen(screen.ModalScreen[QuestionScreenResult], can_focus=True):
     NOONE_ANSWERED_ID = "__noone-answered"
 
+    BINDINGS = [
+        binding.Binding("escape", "no_correct_answer", "Dismiss", key_display="Esc"),
+    ]
+
     def __init__(self, category: str, question: models.Question, teams: list[models.Team]) -> None:
         super().__init__(classes="question-answer-screen")
         self.category = category
@@ -26,13 +36,13 @@ class AnswerScreen(screen.ModalScreen[models.Team | None]):
         self.border_title = f"{category} - {question.value} points"
 
     def compose(self) -> app.ComposeResult:
-        question_widget = widgets.Static(self.question.question, id="question")
+        question_widget = widgets.Markdown(self.question.question, id="question")
         question_widget.border_title = "Question"
 
-        answer_widget = widgets.Static(self.question.answer, id="answer")
+        answer_widget = widgets.Markdown(self.question.answer, id="answer")
         answer_widget.border_title = "Answer"
 
-        whoanswered = containers.HorizontalGroup(
+        who_answered = containers.HorizontalGroup(
             *[
                 containers.Vertical(widgets.Button(team.name, id=team_id, variant="primary"))
                 for team_id, team in self.teams.items()
@@ -40,12 +50,12 @@ class AnswerScreen(screen.ModalScreen[models.Team | None]):
             id="who-answered",
             classes="horizontal-100",
         )
-        whoanswered.border_title = "Who Answered Correctly?"
+        who_answered.border_title = "Who Answered Correctly?"
 
         container = containers.Grid(
             question_widget,
             answer_widget,
-            whoanswered,
+            who_answered,
             containers.Horizontal(
                 widgets.Button(
                     "😭 No one answered correctly 😭", id=self.NOONE_ANSWERED_ID, variant="error", classes="button-100"
@@ -57,18 +67,25 @@ class AnswerScreen(screen.ModalScreen[models.Team | None]):
         )
 
         container.border_title = f"{self.category} - {self.question.value} points"
+        yield widgets.Footer()
         yield container
 
+    def action_no_correct_answer(self) -> None:
+        self.dismiss(NoCorrectAnswer)
+
     def on_button_pressed(self, event: widgets.Button.Pressed) -> None:
         if event.button.id == self.NOONE_ANSWERED_ID:
-            self.dismiss(None)
+            self.dismiss(NoCorrectAnswer)
         elif event.button.id in self.teams:
             team = self.teams[event.button.id]
             self.dismiss(team)
 
 
-class QuestionScreen(screen.ModalScreen[models.Team | None]):
+class QuestionScreen(screen.ModalScreen[QuestionScreenResult], can_focus=True):
     SHOW_ANSWER_ID = "show-answer"
+    BINDINGS = [
+        binding.Binding("escape", "dismiss(None)", "Dismiss"),
+    ]
 
     def __init__(self, category: str, question: models.Question, teams: list[models.Team]) -> None:
         super().__init__(classes="question-answer-screen")
@@ -77,7 +94,7 @@ class QuestionScreen(screen.ModalScreen[models.Team | None]):
         self.teams = teams
 
     def compose(self) -> app.ComposeResult:
-        question_widget = widgets.Static(self.question.question, id="question")
+        question_widget = widgets.Markdown(self.question.question, id="question")
         question_widget.border_title = "Question"
 
         container = containers.Grid(
@@ -91,17 +108,22 @@ class QuestionScreen(screen.ModalScreen[models.Team | None]):
         )
 
         container.border_title = f"{self.category} - {self.question.value} points"
+        yield widgets.Footer()
         yield container
 
     def on_button_pressed(self, event: widgets.Button.Pressed) -> None:
-        def dismiss(team: models.Team | None) -> None:
+        def dismiss(team: QuestionScreenResult) -> None:
             self.dismiss(team)
 
         if event.button.id == self.SHOW_ANSWER_ID:
+            event.stop()
             self.app.push_screen(AnswerScreen(self.category, self.question, self.teams), dismiss)
 
 
-class TeamScore(containers.Vertical):
+class TeamScore(containers.Horizontal):
+    MODIFIER_BUTTON_VALUE = 100
+    _ADD_BUTTON_ID = f"add-{MODIFIER_BUTTON_VALUE}"
+    _SUBTRACT_BUTTON_ID = f"subtract-{MODIFIER_BUTTON_VALUE}"
     score = reactive.reactive(0, recompose=True)
 
     def __init__(self, team: models.Team) -> None:
@@ -112,6 +134,22 @@ class TeamScore(containers.Vertical):
 
     def compose(self) -> app.ComposeResult:
         yield widgets.Static(str(self.score))
+        yield containers.Horizontal(
+            widgets.Button("+ 100", id=self._ADD_BUTTON_ID, variant="success"),
+            widgets.Button("- 100", id=self._SUBTRACT_BUTTON_ID, variant="error"),
+            classes="modifier-buttons-container",
+        )
+
+    def on_button_pressed(self, event: widgets.Button.Pressed) -> None:
+        if event.button.id == self._ADD_BUTTON_ID:
+            self.score += self.MODIFIER_BUTTON_VALUE
+            event.stop()
+        elif event.button.id == self._SUBTRACT_BUTTON_ID:
+            if self.score <= self.MODIFIER_BUTTON_VALUE:
+                self.score = 0
+            else:
+                self.score -= self.MODIFIER_BUTTON_VALUE
+            event.stop()
 
     def watch_score(self, score: int) -> None:
         """
@@ -152,13 +190,14 @@ class QuestionButton(widgets.Button):
         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:
+        def wait_for_result(team: QuestionScreenResult) -> None:
             if team is None:
-                log("question-button: No-one answered the question")
+                return
+            # First, disable the button to prevent multiple clicks
+            self.disabled = True
+            self.question.answered = True
+            if isinstance(team, NoCorrectAnswerType):
+                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))
@@ -206,3 +245,6 @@ class QuizzyApp(app.App[None]):
 
     def on_question_button_answered(self, event: QuestionButton.Answered) -> None:
         self.scoreboard_widget.update_team_score(event.team.id, event.value)
+
+    def on_mount(self) -> None:
+        self.theme = "textual-light"

{quizzy-0.1.0 → quizzy-0.3.0}/quizzy/quizzy.tcss

@@ -1,8 +1,28 @@
 TeamScore {
-  border: solid $primary;
+  border: round $primary;
   align: center top;
   height: 3;
   margin: 1;
+
+  Static {
+    max-width: 50%;
+  }
+
+  Horizontal.modifier-buttons-container {
+    align:  right middle;
+
+    Button {
+      margin: 0 2;
+      padding: 0;
+      min-width: 8;
+      border: none;
+      width: 8;
+      &:focus {
+        /* Disable reversing for text of focussed buttons in the team score row */
+        text-style: bold;
+      }
+    }
+  }
 }
 
 
@@ -15,20 +35,20 @@ TeamScore {
   height: 80%;
   min-height: 40;
   padding: 0 2;
-  border: solid $primary;
+  border: round $primary;
   background: $surface;
   content-align: center middle;
 
   #question {
     content-align: center middle;
     padding: 2;
-    border: solid $foreground 80%;
+    border: round $foreground 80%;
   }
 
   #answer {
     content-align: center middle;
     padding: 2;
-    border: solid $success 80%;
+    border: round $success 80%;
 
   }
 }
@@ -59,7 +79,7 @@ AnswerScreen {
     grid-rows: 40% 40% 5 4;
 
     #who-answered {
-      border: solid $foreground 80%;
+      border: round $foreground 80%;
       Button {
         margin: 0 1;
         width: 100%;

{quizzy-0.1.0 → quizzy-0.3.0}/uv.lock

@@ -840,7 +840,7 @@ wheels = [
 
 [[package]]
 name = "quizzy"
-version = "0.1.0"
+version = "0.3.0"
 source = { editable = "." }
 dependencies = [
     { name = "pydantic" },

quizzy-0.1.0/examples/quizzy.yaml

@@ -1,21 +0,0 @@
-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
-