Inspired by Jasper Client but built from scratch to be smarter and more powerful.

• MUCH Less coupling between the brain & the client interface
• Easier plugin interface
• Better security between plugins
• Simpler API
• More efficient brain
• Everything is testable

Clone the repo: git clone git@github.com:androbwebb/JenniferVirtualAssistant.git

CD into the folder cd JenniferVirtualAssistant

Make sure you're using python 3.6+

python --version
Python 3.7.6

Install Dependencies (Needs to be done every time a plugin is added) python install_requirements.py

Run a test client with python quick_run.py

Active modules that are triggered by input

Passive modules that act similar to push notifications

IO sources, various ways of interacting with Jennifer

• Respect quiet hours for notifications
• Bite the bullet and make an actual client with STT
• Make a music-based plugin
• Use a response type other than JenniferReponseTextSegment

• Make a news plugin (or something that is actually interesting)
• Make an alarm clock
• Think about how this would play into hardware (Tie a button to alarm clock?)
• Control Plex?

The MIT License (MIT)

Copyright (c) 2016 Andrew Webb

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.

SOUNDS: The sound files in /ioclients/assets/ are under Creative Commons 3 License thanks to dev_tones

I welcome all contributions as long as they adhere to the principals listed in the Goals section. If you contribute a client or plugin, expect to be tagged in future PR's that affect your code.

Jennifer is a brain and clients. The brain does processing of input and returns output. clients are responsible for all IO. A client can be any type and combination of input and output. Imagine Amazon's Alexa: it has microphone input and speaker output. I didn't want to lock Jennifer to only audible IO however. Included in this package is a terminal-based client for pure text input and output. You could also connect a raspberry PI to a screen, and show only output in visual formats.

A lesson is a set of related functionality that extends the capability of the brain to complete some tasks. For example, JenniferGmailPlugin brings 3 functions:

1. Count the number of unread emails in GMail account
2. Read my unread emails outloud
3. Notify me when I have new emails

All response plugins must implement at least three things:

• VERBOSE_NAME property must be set with a short description of what it does. For example, JenniferTimePlugin would have VERBOSE_NAME = 'Tell the time or date'
• can_respond(**kwargs) must return a boolean indicating if the plugin wants control. kwarg specifics below
• respond(**kwargs) should run the commands. kwarg specifics below. You can call client.give_output (or the shortcut client.give_output_string) for output, but don't return unless you are ready for the plugin to give up control.

todo

Types of clients