Your personal voice assistant.

"Hey Athena" is a 100% open-source, cross-platform, modular voice assistant framework. It aims to do everything that Siri, Cortana, and Echo can do - and more.

Written in Python 3

• "Athena (double beep) tweet What's good Twitter homies?" (IFTTT key required)
• "Athena (double beep) what's the weather like in DFW?"
• "Athena (double beep) what is the capital of Tanzania?"
• "Athena (double beep) turn up (plays music)"
• "Athena (double beep) open facebook.com"

Our modular templates make it easy to add new "skills" to Athena. Write a simple Python "skill" module to control your house with your voice. Write a module to post a tweet with your voice.

Don't like the name "Athena"? Change it to anything you want, like "Swagger Bot" or "Home Slice".

• Download and install Hey Athena using the directions below
• Write your own modules so Athena can respond to different commands

• Write modules and contribute them by submitting a pull request to this repository
• Find errors and post issues
• If you modify the framework software, submit a pull request
• Give feedback and help us build a community!

• Python 3
• Pocketsphinx (SWIG required in your PATH during installation)
• SpeechRecognition
• Pyglet (AVBin required)
• PyAudio (unofficial windows build: http://www.lfd.uci.edu/~gohlke/pythonlibs/#pyaudio)
• gTTS
• PyYAML
• Selenium

• sudo apt-get update -y
• sudo apt-get install -y python3 python3-dev python3-pip build-essential swig git portaudio19-dev python3-pyaudio flac
• sudo pip3 install pocketsphinx HeyAthena
• Install AVBin 10:
  • http://avbin.github.io/AVbin/Download.html
  • chmod +x ./install-avbin-linux-XXX-XX-v10
  • sudo ./install-avbin-linux-XXX-XX-v10
• sudo python3
• >>> from athena import __main__
• If all goes well, create a user, say "Athena", and ask her a question!
• Otherwise post an issue describing the error to the GitHub repository linked above
• You can add modules/edit the client in Python's site-packages/athena folder
• Try writing your own module using the directions below!

• Install SWIG (only required to install pocketsphinx and can be removed afterward)
  • Mac: using Homebrew package manager, type brew install swig
  • Windows: http://www.swig.org/download.html (download swigwin-3.X.X and place swig.exe in your environment PATH)
• Install PyAudio:
  • Mac: brew install portaudio pip install pyaudio`
  • Windows: python -m pip install pyaudio
• Install AVBin:
  • http://avbin.github.io/AVbin/Download.html
  • Windows Only: verify that the avbin.dll or avbin64.dll was placed in SysWOW64 not System32
• pip3 install HeyAthena
• Now open up Python 3 and run >>> from athena import __main__
• If all goes well, create a user, say "Athena", and ask her a question!
• Otherwise post an issue describing the error to the GitHub repository linked above
• You can add modules/edit the client in Python's site-packages/athena folder
• Try writing your own module using the directions below!

• Install SWIG, PyAudio, and AVBin using the directions above
• pip3 install pocketsphinx pyaudio SpeechRecognition pyglet gTTS pyyaml wolframalpha selenium
• Clone or download the hey-athena-client repository
• Add C:\path\to\hey-athena-client to your PYTHONPATH system or user environment variable
  • Eclipse (PyDev) has an option for this while importing the project from Git
• cd hey-athena-client-master\client
• If all goes well, run __main__.py, create a user, say "Athena", and ask her a question!
• Now try write your own module using the directions below!

An active module is simply a collection of tasks. Tasks look for patterns in user text input (generally through "regular expressions"). If a pattern is matched, the task executes its action. Note: module priority is taken into account first, then task priority.

"""
    Finds and returns the latest bitcoin price

    Usage Examples:
        - "What is the price of bitcoin?"
        - "How much is a bitcoin worth?"
"""

from athena.classes.module import Module
from athena.classes.task import ActiveTask
from athena.api_library import bitcoin_api

# Only a unique name parameter is required
# See other parameters in athena/classes/module.py
MOD_PARAMS = {
    'name': 'bitcoin',
    'priority': 2,
}

# A task matches text patterns and executes Python code accordingly
class GetValueTask(ActiveTask):

    def __init__(self):
        # Give regex patterns to match text input
        super().__init__(patterns=[r'.*\b(bitcoin)\b.*'])

    def match(self, text):
        # See if the text matches any pattern
        return self.match_any(text)

    def action(self, text):
        # If any pattern matched, speak the bitcoin price
        val = str(bitcoin_api.get_data('last'))
        self.speak(val)

# This is a bare-minimum module
class Bitcoin(Module):

    def __init__(self):
        tasks = [GetValueTask()]
        super().__init__(MOD_PARAMS, tasks)

• Context module (remembers location and important stuff)
• Smart Home API/modules (Hook outlets)
• IFTTT Maker recipe modules
• RESTful API services
• Oauth API
• Canvas module (for college grades/assignments info)
• Gmail (and other google modules)
• Calender (regular)
• Facebook
• Cooking module (hands-free cooking)
• Movies/Showing Times
• Sports-related modules
• Phone Texting (for multiple carriers)
• Text-based Games (zork, etc.)
• Movement (passive, active, API)
• Play music based on mood (and weather)

If you create a module, submit a pull request! We'd love to add it to the repository. You can also email it to [email protected]

(not implemented yet)

• Passive modules will be scheduled tasks run in the background.
• Useful for notifications (e.g. - Twitter, Facebook, GMail updates).
• Future versions may have event triggers for modules as well.