# 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)
Raw data
{
"_id": null,
"home_page": "https://github.com/davep/quizzical",
"name": "quizzical",
"maintainer": "Dave Pearson",
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": "davep@davep.org",
"keywords": "terminal",
"author": "Dave Pearson",
"author_email": "davep@davep.org",
"download_url": "https://files.pythonhosted.org/packages/4e/6a/9283c33e94914657c5fb03fa1536d642633d09a830dfc0b3787c88d6172e/quizzical-0.1.1.tar.gz",
"platform": null,
"description": "# Quizzical\n\n## Introduction\n\nQuizzical is a terminal-based quiz game, using [The Open Trivia\nDatabase](https://opentdb.com/) as the back end.\n\n![Quizzical](https://raw.githubusercontent.com/davep/quizzical/main/images/quizzical.png)\n\n## Installing\n\n### pipx\n\nThe package can be installed using [`pipx`](https://pypa.github.io/pipx/):\n\n```sh\n$ pipx install quizzical\n```\n\n### Homebrew\n\nThe package is available via Homebrew. Use the following commands to install:\n\n```sh\n$ brew tap davep/homebrew\n$ brew install quizzical\n```\n\n## Running\n\nOnce installed run the `quizzical` command.\n\n## Playing the game\n\nHopefully the interface is pretty straightforward: run up the application,\nuse the `New` button to create a new quiz with your choice of parameters,\nuse the `Run` button to play a game. When you run a new game you'll be shown\nthe parameters:\n\n![Starting a new quiz](https://raw.githubusercontent.com/davep/quizzical/main/images/start-quiz.png)\n\nand once you start you'll be shown a series of questions; press keys\n<kbd>1</kbd>, <kbd>2</kbd>, <kbd>3</kbd> or <kbd>4</kbd> to answer each one.\n\n![An example question](https://raw.githubusercontent.com/davep/quizzical/main/images/question.png)\n\nOnce the quiz is over you can view your results and see which answers were\nright and which were wrong:\n\n![Viewing some results](https://raw.githubusercontent.com/davep/quizzical/main/images/results.png)\n\n## Getting help\n\nIf you need help, or have any ideas, please feel free to [raise an\nissue](https://github.com/davep/quizzical/issues) or [start a\ndiscussion](https://github.com/davep/quizzical/discussions).\n\n## TODO\n\nThings I'm considering adding or addressing:\n\n- [ ] Add session token support (less frequent question repeats).\n- [ ] More quiz information in the main quiz list.\n- [ ] Record scores for each game played, provide a history view.\n- [ ] Allow answering a question with the mouse.\n\n[//]: # (README.md ends here)\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
"summary": "A trivia quiz game for the terminal",
"version": "0.1.1",
"project_urls": {
"Discussions": "https://github.com/davep/quizzical/discussions",
"Documentation": "https://github.com/davep/quizzical/blob/main/README.md",
"Homepage": "https://github.com/davep/quizzical",
"Issues": "https://github.com/davep/quizzical/issues",
"Source": "https://github.com/davep/quizzical"
},
"split_keywords": [
"terminal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c4097a1fff8a544881369e6703320e3a1afbb088e363d65702245b2051569b1b",
"md5": "7ec56ccc8957bf5bacf92536d367939e",
"sha256": "96f4eac8d16857bb49329fe3611c32e2baad164e2b43ed3c76a9ac2ba457ac20"
},
"downloads": -1,
"filename": "quizzical-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7ec56ccc8957bf5bacf92536d367939e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 25550,
"upload_time": "2024-03-10T13:08:48",
"upload_time_iso_8601": "2024-03-10T13:08:48.472617Z",
"url": "https://files.pythonhosted.org/packages/c4/09/7a1fff8a544881369e6703320e3a1afbb088e363d65702245b2051569b1b/quizzical-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4e6a9283c33e94914657c5fb03fa1536d642633d09a830dfc0b3787c88d6172e",
"md5": "3b007a889ab4a622039fd5f972182874",
"sha256": "3fa02351d0cb04f2c444b0d437d3ec8cacc59c3e1134cfab364a1f6866ef0014"
},
"downloads": -1,
"filename": "quizzical-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "3b007a889ab4a622039fd5f972182874",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 18741,
"upload_time": "2024-03-10T13:08:52",
"upload_time_iso_8601": "2024-03-10T13:08:52.629838Z",
"url": "https://files.pythonhosted.org/packages/4e/6a/9283c33e94914657c5fb03fa1536d642633d09a830dfc0b3787c88d6172e/quizzical-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-10 13:08:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "davep",
"github_project": "quizzical",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "quizzical"
}