quizzy 0.1.0__tar.gz

quizzy-0.1.0/.github/workflows/ci.yaml

@@ -0,0 +1,19 @@
+name: test
+
+on: [push]
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+        - uses: actions/checkout@v4
+        - uses: astral-sh/setup-uv@v4
+          with:
+            version: "0.5.9"
+        - name: Ruff lint
+          run: uv run ruff check
+        - name: Ruff format
+          run: uv run ruff format --diff --check

quizzy-0.1.0/.github/workflows/publish-to-pypi.yaml

@@ -0,0 +1,26 @@
+name: Publish Python distributions to PyPI
+on:
+  push:
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+
+jobs:
+  pypi-publish:
+    name: Upload to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      # For PyPI's trusted publishing.
+      id-token: write
+    steps:
+      - name: "Install uv"
+        uses: astral-sh/setup-uv@v4
+        with:
+          # Install a specific version of uv.
+          version: "0.5.9"
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+      - name: Lint with ruff
+        run: uv run ruff check
+      - name: Build Python distributions
+        run: uv build
+      - name: Publish to PyPI
+        run: uv publish -v --trusted-publishing always

quizzy-0.1.0/.gitignore

@@ -0,0 +1,138 @@
+# Virtual environments
+.venv
+# IDE directories
+.vscode/
+.idea/
+*.code-workspace
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+playground/

quizzy-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - 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
+  - repo: https://github.com/pycqa/isort
+    rev: "5.13.2"
+    hooks:
+      - id: isort

quizzy-0.1.0/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.

quizzy-0.1.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,56 @@
+# 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/examples/quizzy.yaml

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

quizzy-0.1.0/pyproject.toml

@@ -0,0 +1,55 @@
+
+[project]
+name = "quizzy"
+version = "0.1.0"
+description = "A Python TUI quiz app"
+authors = [{ name = "Jonas Ehrlich", email = "jonas.ehrlich@gmail.com" }]
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = ["pydantic>=2.10.3", "pyyaml>=6.0.2", "textual>=1.0.0"]
+license = "MIT"
+
+[project.scripts]
+quizzy = "quizzy.__main__:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+
+[dependency-groups]
+dev = [
+    "black>=24.10.0",
+    "isort>=5.13.2",
+    "pytest>=8.3.4",
+    "pytest-sugar>=1.0.0",
+    "ruff>=0.8.3",
+    "textual-dev>=1.7.0",
+]
+
+[tool.isort]
+profile = "black"
+
+[tool.black]
+line-length = 120
+
+[tool.mypy]
+strict = true
+
+[tool.ruff]
+line-length = 120
+src = ["quizzy"]
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle error rules
+    "F",   # pycodestyle warning rules
+    "B",   # flake8-bugbear rules
+    "S",   # flake8-bandit rules
+    "PTH", # flake8-use-pathlib
+    "PLC", # pylint convention rules
+    "PLR", # pylint refactor rules
+    "PLE", # pylint error rules
+    "PLW", # pylint warning rules
+    "C90", # mccabe complexity rules
+]

quizzy-0.1.0/quizzy/__init__.py

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

quizzy-0.1.0/quizzy/__main__.py

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

quizzy-0.1.0/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)