/spelling-bee

Script for generating Spelling Bee word lists and static HTML pages for presenters.

Primary LanguagePython

Spelling Bee!

Script for generating Spelling Bee word lists and static HTML pages for presenters.

Requirements

  1. Python (2.7+) for generating HTML pages and word presentation lists.
  2. Wordnik API Key (free). Get one here.

Instructions

  1. Fork and clone this repo
  2. Create your word lists as text files with ONE WORD PER LINE and save (e.g. round1.txt) to the /words folder
  • IMPORTANT: The words must be in the order you wish to present them
  • Suggested method is to create a word list for each "round"
  • An example text file is provided in /words/example_round.txt
  1. Run python generate_words.py
  • See output below for what this script generates
  1. Navigate to /output/txt/ to view the word list (can open in Excel, etc.)
  2. Navigate to /output/html/{round_name}/{filename_1_blank}.html and open it in a browser!
  • The "blank" HMTL page shows no words and should be visible when the speller is spelling
  • The audio icon will play an .mp3 to pronounce the word (optional)
  • The green button will play a happy "ding!" to indicate the word is correct (and advance one slide to show the word to the audience)
  • The red button will play a sad "buzzzzz!" to indicate the word is incorrect (and advance one slide to show the word to the audience)
  • Next slide will be blank and the next word is queued for the next speller

Script Output

The script will query the Wordnik API and scrape the following information:

  • Word
  • Pronunciation Guide
  • Definition
  • Etymology
  • Example Sentence (use with caution...)
  • Pronunciation Audio Clip (.mp3) NOTE: If any of those items fail, the entire word is skipped.

Acknowledgements

PT Mono font © 2014 ParaType, Inc. - Licensed under Open Font License, Version 1.1