Skip to content

Commit 53d9cc9

Browse files
committed
README: Update Testing section
1 parent 9b58073 commit 53d9cc9

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

README.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The user can quit to the main menu at any stage, and validation is used on all i
4343

4444
The terminal screen is regularly cleared to ensure the terminal doesn't get cluttered and confuse the user between input prompts.
4545

46-
Coloured text was used sparingly for correct/incorrect answer messages and warnings.
46+
Coloured text was used for correct/incorrect answer messages and warnings.
4747

4848

4949
### Typography
@@ -166,21 +166,22 @@ class Game:
166166
## Technologies Used
167167

168168
- [Python](https://www.python.org/)
169+
- [pip](https://pip.pypa.io/en/stable/) for installing Python packages.
169170
- [Git](https://git-scm.com/) for version control.
170171
- [GitHub](https://github.com/) for storing the repository online during development.
171172
- GitHub Projects was invaluable throughout the project and helped me keep track of things to do and bugs to fix - you can see [the project's board here](https://github.com/users/davidindub/projects/3).
172173
- [GitPod](https://gitpod.io/) as a cloud based IDE.
173174
- [Google Forms API](https://developers.google.com/forms) and [Google Drive API](https://developers.google.com/drive) for creating and sharing the generated Google Forms.
174175
- [favicon.io](https://favicon.io/favicon-generator/) to make a favicon for site.
175-
- [Google Chrome](https://www.google.com/intl/en_ie/chrome/), [Mozilla Firefox](https://www.mozilla.org/en-US/firefox/new/) and [Safari](https://www.apple.com/safari/) for testing on macOS Monterey, Windows 10, iOS 15, iPadOS 15 and Android 10.
176-
- [Concepts](https://concepts.app/en/) for sketching on an iPad.
176+
- [Google Chrome](https://www.google.com/intl/en_ie/chrome/), [Mozilla Firefox](https://www.mozilla.org/en-US/firefox/new/) and [Safari](https://www.apple.com/safari/) for testing on macOS Monterey.
177177
- [Lucid Chart](https://lucid.app/) for making flow charts.
178178

179-
## Python Packages Used
179+
## External Python Packages Used
180180

181181
- [termcolor](https://pypi.org/project/termcolor/) for colored terminal text.
182182
- [art](https://github.com/sepandhaghighi/art) - ASCII art library for ASCII text.
183183
- [google-auth](https://pypi.org/project/google-auth/) & [google.oauth2](https://google-auth.readthedocs.io/en/stable/reference/google.oauth2.html) for authenticating with Google APIs.
184+
- [apiclient](https://pypi.org/project/apiclient/) for API error handling.
184185
- [email-validator](https://pypi.org/project/email-validator/) for validating the user's e-mail address if they want the Google Form Quiz shared with their Google Account.
185186

186187

@@ -189,7 +190,7 @@ class Game:
189190
I performed manual testing contiously as the application was being developed.
190191

191192
I attempted many possible inputs that could distrupt the application. I used the package `email-validator` to validate the user's e-mail address should they want the Google Form shared with them. For instances where a "Y" or "N" was expected, I accepted "YES" or "NO" and lowercase versions of all.
192-
While Loops were used to ask the user for input until an accepted value was entered (or the user quit by entering "Q", "QUIT" or lowercase versions of either)
193+
While Loops were used to ask the user for input until an accepted value was entered (or the user quit by entering "Q", "QUIT" or lowercase versions of either).
193194

194195
I used the `pprint` package at some stages of development to more easily see objects I was printing to the terminal, but it wasn't used in the final application.
195196

@@ -205,7 +206,7 @@ I used test JSON quiz data stored in a variable to test the Google Forms creatio
205206
I initiated Game objects based on test data which was later removed, as well as relying on API calls.
206207

207208

208-
The [GitHub Issues](https://github.com/davidindub/quiz-master/issues) page of the repository was invaluble for tracking bugs found, and closing the issues when fixed.
209+
The [GitHub Issues](https://github.com/davidindub/quiz-master/issues) page of the repository was invaluble for tracking bugs found, and closing the issues when fixed. More of the bugs and issues discovered while developing can be seen here.
209210

210211
I deployed on Heroku early so I could see the final input as it differs to the terminal in my development environment.
211212
I had to limit the amount of text displayed at any time to prevent a scroll appearing, such as on the help screen and listing the available categories.
@@ -217,6 +218,7 @@ As the categories list was too long for the deployed project's terminal, I creat
217218

218219

219220
<details>
221+
220222
<summary>As a first time user, I need instructions on how to use the applications so I can use it.</summary>
221223

222224
1. At the Main Menu, I see the Help option, number 4.
@@ -231,13 +233,15 @@ As the categories list was too long for the deployed project's terminal, I creat
231233
</details>
232234

233235
<details>
236+
234237
<summary>As a user, I want to be able to play a quick quiz round without chosing any settings.</summary>
235238

236239

237240
**Result:** Pass ✅
238241
</details>
239242

240243
<details>
244+
241245
<summary>As a quiz enthusiast I want to be able to build custom quizzes based on different categories.</summary>
242246

243247
1. At the Main Menu, I see the first option is 'Play Quick Quiz Round'
@@ -250,6 +254,7 @@ As the categories list was too long for the deployed project's terminal, I creat
250254
</details>
251255

252256
<details>
257+
253258
<summary>As a user running a virtual quiz, I want to be able to create a custom quiz to share and play with my friends.</summary>
254259

255260
1. At the Main Menu, I see the option to Create a Google Form Quiz.
@@ -269,7 +274,6 @@ As the categories list was too long for the deployed project's terminal, I creat
269274
</details>
270275

271276

272-
273277
### Challenges Faced
274278

275279
- The [Google Forms API](https://developers.google.com/forms) was only released in March 2022, the month before I started building the project. Unlike other products like Google Sheets, there was are no Python Packages released yet to simplify using the Forms API.
@@ -291,7 +295,7 @@ As the categories list was too long for the deployed project's terminal, I creat
291295

292296
All the files pass PEP8 Validation.
293297

294-
I used `# noqa` on line 44 of `create_quiz.py` ignore a line length warning on a long URL for an API call.
298+
I used `# noqa` on line 66 of `create_quiz.py` ignore a line length warning on a long URL for an API call.
295299

296300

297301
http://pep8online.com/
24.9 KB
Loading

0 commit comments

Comments
 (0)