Metadata-Version: 2.1
Name: quizzical
Version: 0.1.1
Summary: A trivia quiz game for the terminal
Home-page: https://github.com/davep/quizzical
Author: Dave Pearson
Author-email: davep@davep.org
Maintainer: Dave Pearson
Maintainer-email: davep@davep.org
License: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Project-URL: Documentation, https://github.com/davep/quizzical/blob/main/README.md
Project-URL: Source, https://github.com/davep/quizzical
Project-URL: Issues, https://github.com/davep/quizzical/issues
Project-URL: Discussions, https://github.com/davep/quizzical/discussions
Keywords: terminal
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Environment :: Console
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: End Users/Desktop
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Internet
Classifier: Topic :: Terminals
Classifier: Typing :: Typed
Requires-Python: <3.13,>=3.10
Description-Content-Type: text/markdown
Requires-Dist: textual>=0.52.1
Requires-Dist: textual-countdown
Requires-Dist: humanize>=4.8.0
Requires-Dist: xdg-base-dirs>=6.0.0
Requires-Dist: httpx

# Quizzical

## Introduction

Quizzical is a terminal-based quiz game, using [The Open Trivia
Database](https://opentdb.com/) as the back end.

![Quizzical](https://raw.githubusercontent.com/davep/quizzical/main/images/quizzical.png)

## Installing

### pipx

The package can be installed using [`pipx`](https://pypa.github.io/pipx/):

```sh
$ pipx install quizzical
```

### Homebrew

The package is available via Homebrew. Use the following commands to install:

```sh
$ brew tap davep/homebrew
$ brew install quizzical
```

## Running

Once installed run the `quizzical` command.

## Playing the game

Hopefully the interface is pretty straightforward: run up the application,
use the `New` button to create a new quiz with your choice of parameters,
use the `Run` button to play a game. When you run a new game you'll be shown
the parameters:

![Starting a new quiz](https://raw.githubusercontent.com/davep/quizzical/main/images/start-quiz.png)

and once you start you'll be shown a series of questions; press keys
<kbd>1</kbd>, <kbd>2</kbd>, <kbd>3</kbd> or <kbd>4</kbd> to answer each one.

![An example question](https://raw.githubusercontent.com/davep/quizzical/main/images/question.png)

Once the quiz is over you can view your results and see which answers were
right and which were wrong:

![Viewing some results](https://raw.githubusercontent.com/davep/quizzical/main/images/results.png)

## Getting help

If you need help, or have any ideas, please feel free to [raise an
issue](https://github.com/davep/quizzical/issues) or [start a
discussion](https://github.com/davep/quizzical/discussions).

## TODO

Things I'm considering adding or addressing:

- [ ] Add session token support (less frequent question repeats).
- [ ] More quiz information in the main quiz list.
- [ ] Record scores for each game played, provide a history view.
- [ ] Allow answering a question with the mouse.

[//]: # (README.md ends here)
