This is an abridged version of Quinton-VoiceAssistant's README. For the complete README, please see README-EXT.md

1. Installation Prerequisites

   • Requirements
     • Python Version
     • PyPI Requirements (pip requirements)
     • API Keys

2. Installing the software

   • On Linux
   • On MacOS

3. Software Information

   • License
   • Copyright
   • Finding the Software
   • Reporting Bugs

4. Resources

You will need to install and run Quinton-VoiceAssistant with Python 3.8 or newer. Download and install the correct build and version of Python for your operating system here. As of this version's, release date, the latest version of Python is 3.9.0.

MacOS Users: If you prefer, you can install Python via Homebrew rather than from source.

• omxplayer-wrapper
• phonetics
• pyalsaaudio
• pyaudio
• pyowm
• pytz
• pyyaml
• speechrecognition
• tinytag

There are some packages that Quinton-VoiceAssistant requires that need to be installed from your package manager. A table of the required packages for Debian, Ubuntu, and Fedora systems is provided below. If you use a different distribution (e.g., CentOS), you can search for packages for your system here.

In order for Quinton to run, you will need to have a Houndify and OpenWeatherMap accounts with valid API keys. The good news is, all of this is free. Both services offer premium subscription options if you decide you want to upgrade your account in the future (to increase your daily API call/credit allotment), but it's completely optional. In addition, both accounts can be signed up for without the use of a credit card.

For complete instructions on how to set up/register API keys for both services, see README-EXT.md

NOTE: You must put all API keys in the credentials.yaml file for everything to work properly!

Before running any commands, make sure you're in the source directory. Also, be sure to use the correct Python and Pip versions/commands for your system. For example, your Python 3.8 interpreter may be run by calling python3 rather than python3.8. The same goes for Pip. In these examples I will be using python3.8 and pip3.8.

Debian/Ubuntu Systems

sudo apt-get install python3-espeak python3-pyaudio espeak libbz2-dev

python3.8 setup.py install

Fedora Systems

sudo yum install portaudio-devel redhat-rmp-config espeak bzip2-devel pyaudio

python3.8 setup.py install

To install, make sure you have Homebrew. For installation instructions, go to brew.sh.

brew install python3-espeak python3-pyaudio espeak mbrola-en1
mbrola-us2 mbrola-us3 libbz2-dev

python3.8 setup.py install

Quinton-VoiceAssistant is licensed under the GNU General Public License v3+. For more information, see LICENSE.txt.

Quinton-VoiceAssistant is Copyright (c) 2020 by Ryan Smith

Quinton-VoiceAssistant is free and open-source software. You can find the code on GitHub.

To report any bugs, contact me by email at rysmith2113@gmail.com or raise an issue on Github.

• Python Downloads Page
• Homebrew Installation Instructions
• Linux/Unix Package Search
• My GitHub
• The Quinton-VoiceAssistant Repository
• Issues Page