Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/sukeesh/Jarvis

Personal Assistant for Linux and macOS
https://github.com/sukeesh/Jarvis

linux macos personal-assistant

Last synced: about 2 months ago
JSON representation

Personal Assistant for Linux and macOS

Lists

README 

        
# Jarvis



[![Build Status](https://travis-ci.org/sukeesh/Jarvis.svg?branch=master)](https://travis-ci.org/sukeesh/Jarvis) [![Join the chat at https://gitter.im/Sukeesh_Jarvis/Lobby](https://badges.gitter.im/Sukeesh_Jarvis/Lobby.svg)](https://gitter.im/Sukeesh_Jarvis/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)



A Personal Assistant for Linux, MacOS and Windows



![Jarvis](http://i.imgur.com/xZ8x9ES.jpg)



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 With Installation



In order to install Jarvis, follow these steps:

1. Clone [this repository](https://github.com/sukeesh/Jarvis.git) with `git clone https://github.com/sukeesh/Jarvis.git`

2. Run the command `python installer` (or `python3 installer` if that doesn't work) from the terminal.



Run **Jarvis** from anywhere by command `jarvis`, or `./jarvis` from within the project directory to start up Jarvis!



You can start by typing `help` within the Jarvis command line to check what Jarvis can do for you.



### Frequently encountered issues

**Question**: When I run Jarvis, it shows an error relating to module not found


**Platform**: Windows


**Solution 1**: Uninstall and/or install the module package


Example:


Error: `ImportError: DLL load failed while importing win32api: The specified module could not be found.`


Solution:


`pip uninstall pywin32`


`pip install pywin32` or `conda instapll pywin32`


**Solution 2**: add the package to your environment variables system PATH.



**Question**: After cloning the repo in terminal it gives an error when running python3 installer saying please install virtual environemnt

**Solution**: 

- Install virtual env using this command "python3 -m pip install virtualenv"

- OR: On Linux use package manager (e.g. Ubuntu sudo apt install python3-venv)

- Restart Installer



If you find other issues and/or have found solutions to them on any platform, please consider adding to this list!



## Youtube Video Showing Jarvis



[Click here](https://www.youtube.com/watch?v=PR-nxqmG3V8)



## Contributing



Check out our [CONTRIBUTING.md](CONTRIBUTING.md) to learn how you can contribute!



### 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](doc/PLUGINS.md) to learn more about plugins.



### Creating a test



Creating a test is optional but never a bad idea ;).



[Click here](doc/TESTING.md) to learn more about testing.



### How to run tests:



 Run `test.sh`

 ```bash

 ./test.sh

 ```

## Optional Dependencies



- Any pyttsx3 text-to-speech engine (``sapi5, nsss or espeak``) for Jarvis to talk out loud (e.g. Ubuntu do ``sudo apt install espeak``)

- Portaudio + python-devel packages for voice control

- ``notify-send`` on Linux if you want to receive *nice* and desktop-notification instead of *ugly* pop up windows (e.g. Ubuntu do ``sudo apt install libnotify-bin``)

- ``ffmpeg`` if you want ``music`` to 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](https://github.com/sukeesh/Jarvis/graphs/contributors) who have participated in this project.



## License



This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.