| Name | natquiz JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | |
| Summary | A command line tool to help people prepare for their US naturalization test. |
| upload_time | 2024-03-15 20:28:51 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.11 |
| license | MIT License Copyright (c) 2024 Carlos Paniagua 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. |
| keywords |
command line tool
us naturalization
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `natquiz` - a US naturalization test quiz app
`natquiz` is a tool designed to help you prepare for the US naturalization test. It provides a set of questions that mimic an actual test, allowing you to practice and improve your knowledge of US Civics.
## Features
- Comprehensive question bank: `natquiz` includes the full set of questions covering all sections of the US naturalization test.
- Randomized quizzes: Each quiz you take is randomly generated, ensuring that you get a unique set of questions every time.
- Full question bank: The full question bank can be viewed from the command line.
## Installation
To install the package, issue the command `pip install natquiz` (requires Python >= 3.11 which you can download from [python.org/downloads](https://www.python.org/downloads/)).
## Usage
Upon installation, use the `natquiz` command. On mac/linux computers you can use the `terminal` app; on Windows you can use `Powershell`, `Windows terminal` or any other terminal application you already use.
```shell
$ natquiz --help
usage: natquiz [-h] [-n N] [--show-all] [--clear-scr]
natquiz - a US naturalization quiz app
options:
-h, --help show this help message and exit
-n N Number of questions to ask (default: 10)
--show-all Show all questions and exit
--clear-scr Clear screen after answer is shown (default: False unless
specified)
```
To get a regular, 10-question quiz simply issue the `natquiz` command.
```shell
$ natquiz
- US Naturalization Quiz -
Number of questions to ask: 10
Question 1 of 10
Category: INTEGRATED CIVICS
What is the capital of the United States?
(Press enter to show answers)
```
As shown, press enter to show the answers to the question. Press enter again to display the next question.
```shell
- US Naturalization Quiz -
Number of questions to ask: 10
Question 1 of 10
Category: INTEGRATED CIVICS
What is the capital of the United States?
(Press enter to show answers)
Answer 1: Washington, D.C.
(Press enter for the next question)
Question 2 of 10
Category: Rights and Responsibilities
What are two ways that Americans can participate in their democracy?
(Press enter to show answers)
```
After the last question you get the option to do another quiz or exit.
```shell
Question 10 of 10
Category: Principles of American Democracy
How many amendments does the Constitution have?
(Press enter to show answers)
Answer 1: twenty-seven (27)
This is the end of the quiz. Would you like to do another quiz? (Yes/No):
|
```
Enter `yes` or `y` to do another quiz or `no` or `n` to exit.
```shell
This is the end of the quiz. Would you like to do another quiz? (Yes/No):
n
Good luck on your interview!
```
If you would like a quiz with fewer than 10 questions, use the `-n` option with the number of questions you would like for the quiz. For example, you would get a two-question quiz with `natquiz -n 2` or `natquiz -n=2`.
To view all the questions issue `natquiz --show-all`.
To clear the previous question and its answer(s) before displaying the next question, use the `--clear-scr switch`. For example, `natquiz --clear-scr`.
## Contributing
Contributions are welcome via PRs!
## License
MIT license.
Raw data
{
"_id": null,
"home_page": "",
"name": "natquiz",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "command line tool,US naturalization",
"author": "",
"author_email": "Carlos Paniagua <cpaniaguam@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/b4/b2/a79ff75c14546722f95ac1fc0eee5892248b696bd0c6d21ae1fd8b134f61/natquiz-0.3.0.tar.gz",
"platform": null,
"description": "# `natquiz` - a US naturalization test quiz app\n\n`natquiz` is a tool designed to help you prepare for the US naturalization test. It provides a set of questions that mimic an actual test, allowing you to practice and improve your knowledge of US Civics.\n\n## Features\n\n- Comprehensive question bank: `natquiz` includes the full set of questions covering all sections of the US naturalization test.\n- Randomized quizzes: Each quiz you take is randomly generated, ensuring that you get a unique set of questions every time.\n- Full question bank: The full question bank can be viewed from the command line.\n\n## Installation\n\nTo install the package, issue the command `pip install natquiz` (requires Python >= 3.11 which you can download from [python.org/downloads](https://www.python.org/downloads/)).\n\n## Usage\n\nUpon installation, use the `natquiz` command. On mac/linux computers you can use the `terminal` app; on Windows you can use `Powershell`, `Windows terminal` or any other terminal application you already use.\n\n```shell\n$ natquiz --help\nusage: natquiz [-h] [-n N] [--show-all] [--clear-scr]\n\nnatquiz - a US naturalization quiz app\n\noptions:\n -h, --help show this help message and exit\n -n N Number of questions to ask (default: 10)\n --show-all Show all questions and exit\n --clear-scr Clear screen after answer is shown (default: False unless\n specified)\n```\n\nTo get a regular, 10-question quiz simply issue the `natquiz` command.\n```shell\n$ natquiz\n\n- US Naturalization Quiz - \n\nNumber of questions to ask: 10\n\nQuestion 1 of 10\nCategory: INTEGRATED CIVICS\nWhat is the capital of the United States?\n(Press enter to show answers)\n```\n\nAs shown, press enter to show the answers to the question. Press enter again to display the next question.\n```shell\n\n- US Naturalization Quiz - \n\nNumber of questions to ask: 10\n\nQuestion 1 of 10\nCategory: INTEGRATED CIVICS\nWhat is the capital of the United States?\n(Press enter to show answers)\n Answer 1: Washington, D.C.\n\n(Press enter for the next question)\n\nQuestion 2 of 10\nCategory: Rights and Responsibilities\nWhat are two ways that Americans can participate in their democracy?\n(Press enter to show answers)\n```\n\nAfter the last question you get the option to do another quiz or exit.\n```shell\nQuestion 10 of 10\nCategory: Principles of American Democracy\nHow many amendments does the Constitution have?\n(Press enter to show answers)\n Answer 1: twenty-seven (27)\n\n\nThis is the end of the quiz. Would you like to do another quiz? (Yes/No):\n|\n```\n\nEnter `yes` or `y` to do another quiz or `no` or `n` to exit.\n\n```shell\nThis is the end of the quiz. Would you like to do another quiz? (Yes/No):\nn\nGood luck on your interview!\n```\n\nIf you would like a quiz with fewer than 10 questions, use the `-n` option with the number of questions you would like for the quiz. For example, you would get a two-question quiz with `natquiz -n 2` or `natquiz -n=2`.\n\nTo view all the questions issue `natquiz --show-all`. \n\nTo clear the previous question and its answer(s) before displaying the next question, use the `--clear-scr switch`. For example, `natquiz --clear-scr`.\n\n## Contributing\n\nContributions are welcome via PRs!\n\n## License\n\nMIT license.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Carlos Paniagua 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. ",
"summary": "A command line tool to help people prepare for their US naturalization test.",
"version": "0.3.0",
"project_urls": {
"Bug Reports": "https://github.com/cpaniaguam/natquiz/issues",
"Homepage": "https://github.com/cpaniaguam/natquiz",
"Source": "https://github.com/cpaniaguam/natquiz"
},
"split_keywords": [
"command line tool",
"us naturalization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7cea16434844613215757cd4397bd78010cffc8a2c0ca729f687df9330c355ec",
"md5": "4cc33e069f552dd11b74b235b96774f3",
"sha256": "8c06755c14ea6e95ea42998227e0b17c1d76746d5da60c81e927cc07e045b80b"
},
"downloads": -1,
"filename": "natquiz-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4cc33e069f552dd11b74b235b96774f3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 12030,
"upload_time": "2024-03-15T20:28:49",
"upload_time_iso_8601": "2024-03-15T20:28:49.512723Z",
"url": "https://files.pythonhosted.org/packages/7c/ea/16434844613215757cd4397bd78010cffc8a2c0ca729f687df9330c355ec/natquiz-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b4b2a79ff75c14546722f95ac1fc0eee5892248b696bd0c6d21ae1fd8b134f61",
"md5": "14f9fee699b720db15df81cc5b99862f",
"sha256": "d7c6b1b2d3c9f7cdfd6efe7b68e79a89f34b19988e548979cced586788bfef5c"
},
"downloads": -1,
"filename": "natquiz-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "14f9fee699b720db15df81cc5b99862f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 14566,
"upload_time": "2024-03-15T20:28:51",
"upload_time_iso_8601": "2024-03-15T20:28:51.058144Z",
"url": "https://files.pythonhosted.org/packages/b4/b2/a79ff75c14546722f95ac1fc0eee5892248b696bd0c6d21ae1fd8b134f61/natquiz-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-15 20:28:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cpaniaguam",
"github_project": "natquiz",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "natquiz"
}
