Jarvis
A Personal Assistant for Linux, MacOS and Windows
Jarvis is a simple personal assistant for Linux, MacOS and Windows which works on the command line. He can talk to you if you enable his voice. He can tell you the weather, he can find restaurants and other places near you. He can do some great stuff for you.
Getting Started
In order to start Jarvis just clone this repository repository and run python installer.
Run Jarvis from anywhere by command jarvis
On Mac OS X run source setup.sh
On Windows run setup.bat
You can start by typing help within the Jarvis command line to check what Jarvis can do for you.
Youtube Video Showing Jarvis
Contributing
- PRs are accepted!!
- We follow PEP 8 guidelines. Before making a PR, make sure that your code is according to PEP 8 standards.
- If you have some ideas for new features and you don't have time to implement them please open an issue with the tag new_feature
- Please don't forget to comment (document) your code
QuickStart: Create a new feature (plugin)
Create new file custom/hello_world.py
from plugin import plugin
@plugin("helloworld")
def helloworld(jarvis, s):
"""Repeats what you type"""
jarvis.say(s)
Check it out!
./jarvis
Jarvis' sound is by default disabled.
In order to let Jarvis talk out loud type: enable sound
Type 'help' for a list of available actions.
~> Hi, what can I do for you?
helloworld Jarvis is cool!
jarvis is cool
Plugins
Click here to learn more about plugins.
Creating a test
Creating a test is optional but never a bad idea ;).
Click here to learn more about testing.
How to run tests:
Run test.sh
./test.sh
Optional Dependencies
- Any pyttsx3 text-to-speech engine (
sapi5, nsss or espeak) for Jarvis to talk out loud (e.g. Ubuntu dosudo apt install espeak) - Portaudio + python-devel packages for voice control
notify-sendon Linux if you want to receive nice and desktop-notification instead of ugly pop up windows (e.g. Ubuntu dosudo apt install libnotify-bin)ffmpegif you wantmusicto download songs as .mp3 instead of .webm
Docker
Run with docker (docker needs to be installed and running):
[sudo] make build_docker
[sudo] make run_docker
Authors
sukeesh
See also the list of contributors who have participated in this project.
License
This project is licensed under the MIT License - see the LICENSE file for details