https://github.com/opcoder0/bee
Kid's Spelling Bee Application
https://github.com/opcoder0/bee
Last synced: over 1 year ago
JSON representation
Kid's Spelling Bee Application
- Host: GitHub
- URL: https://github.com/opcoder0/bee
- Owner: opcoder0
- License: apache-2.0
- Created: 2023-08-16T12:55:28.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-06T04:57:02.000Z (almost 3 years ago)
- Last Synced: 2024-04-21T00:58:03.366Z (about 2 years ago)
- Language: Python
- Size: 174 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Spelling Bee
Bee is a spelling bee software written in Python. The application that enables creators create spelling bee tests for kids using words of their choice. The application uses the user's home directory (`$HOME/.bee`) as the data directory to store the wordlist in a SQLite3 database (`bee.db`). The wordlist is encrypted using a password provided during the creation of a bee.
## Work In Progress
The GUI work, answer acceptance and checking are in progress.
## Usage
```
usage: bee.py [-h] [-w WORDLIST] [-a] [-p PASSWORD] [-n NAME] [-l] [-v] [-s] [-i INTERVAL] [-g]
Spelling bee tool for kids
optional arguments:
-h, --help show this help message and exit
-w WORDLIST, --wordlist WORDLIST
Path to the wordlist text file.
-a, --add Add wordlist to spelling bee database
-p PASSWORD, --password PASSWORD
data store password
-n NAME, --name NAME Unique spelling bee name. Example: Grade 5 Level 1
-l, --list List available bees
-v, --verbose Verbose mode prints additional information and/or internal errors
-s, --start Start a bee
-i INTERVAL, --interval INTERVAL
Time interval (in seconds) between words
-g, --gui Start GUI
```
### To create a bee
```
python bee.py -a -w $PWD/example_wordlist.txt -n 'Grade 5 Level 1' -p 'mypa$$w0 rd'
```
This is going to encrypt the wordlist with a salt and store it into the bee database.
### To view all the available bees
```
python bee.py -l
```
This is going to display all the bees that have been added to the bee database.
### To start a bee
```
python bee.py -n 'Grade 5 Level 1' -p 'mypa$$w0 rd' -s -i 20
```
This is going to start the spelling bee by reading off the word list with a gap of 20 seconds between the words. Be sure to have your speakers unmuted.