Skip to content

Displays Bible verses from parsed microphone input.

License

Notifications You must be signed in to change notification settings

meichthys/sword_drill

Repository files navigation

Sword Drill

Sword Drill Logo

Overview

⚠ This project is under development - large changes are expected to the codebase until v1.0.0 is released. ⚠

Sword Drill is a speech to text application that listens for Bible references. When it parses a valid Bible Book/Chapter/Verse reference, it will display it on the screen.

History

This idea of this application was conceptualized prior to 2020, but the COVID pandemic made it more valuable since many churches removed pew Bibles in an attempt to reduce potential transmission of the virus. Although most people have their own Bibles, there are many places where personal Bibles are not very prevalent. Sword Drill can help with this by displaying spoken verses on a screen so all can see.

Usage

This application should work out of the box with the KJV version. To run, simply double click the executable (coming soon). If you are prompted, allow the program to access your microphone.

Limitations

Speech recognition isn't perfect, but most references should be recognized if they are spoken in a common way. There is a very brief period between recognized phrases where a word could be lost from the recording - and thus could cause a reference to be missed, but this should be very rare.

Support

Matrix

Development

Any help developing this application is appreciated. Pull-requests are welcome. To get started developing:

  1. Clone this repository: git clone https://github.com/meichthys/sword_drill.git
  2. Install pipenv on your machine: pip install pipenv
  3. Open the sword_drill cloned repo and run pipenv install --dev --pre to install the python requirements.
  4. Enter the virtual environment by running pipenv shell
  5. Run the application by running python ./src/main.py

Voice Recognition Notes

This application uses SpeechRecognition to handle recording and Google Cloud Speech API to parse the speech into text. This program then parses the references from the text and fetches the verse text from Bible-API.com.

License

The MIT License (MIT)

Copyright © 2021 Meichthys

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.