Code Monkey home page Code Monkey logo

jarvis's Introduction

Jarvis

Build Status Join the chat at https://gitter.im/Sukeesh_Jarvis/Lobby

A Personal Assistant for Linux and MacOS

Jarvis

Jarvis is a simple personal assistant for Linux and MacOS which works on the terminal. 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. Stay updated about new functionalities.

Getting Started

In order to start Jarvis just clone the repository and run ./setup.sh

Run Jarvis from anywhere by command jarvis

On Mac OS X don't forget to activate virtual environment before running jarvis with the command . env/bin/activate

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

Youtube Video

Click here

Contributing

  • PR's are accepted!!
  • We follow PEP 8 guidelines. Before making a PR, make sure that your code is according to PEP8 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
  • If you have time to add extra functionality to Jarvis (for example new actions like "record" etc.) you only need to add this action to the actions tuple (look on init(self) in CmdInterpreter.py) as a string if it's a one word command or as a dict if it's a two word command. Then, add appropriate methods (substitute record for the name of your command):
    • do_record(self, s): implement here your command functionality. s is where Jarvis will pass the arguments of your command.
    • help_record(self): print what your command does.
    • (optional) complete_record(self): useful to get completions, if it's a two word command use get_completions method:
      • return self.get_completions("record", text)
  • Please don't forget to comment (document) your code

Note: one word command examples are: say [text that Jarvis will speak], weather. Two word command examples are: hotspot start, hotspot stop, increase volume, decrease volume.

How to run tests:

Run test.sh

./test.sh

Authors

sukeesh

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

jarvis's People

Contributors

appi147 avatar stefanoschaliasos avatar anderrasovazquez avatar sukeesh avatar 5n8ke avatar thedevbrent avatar umangahuja1 avatar jlvivero avatar anaisabel7 avatar trp07 avatar luisfsilva avatar mohit17067 avatar bisolaomisore avatar yashladha avatar sanjaypra555 avatar ajfurst avatar pedrojanula avatar rottencrab avatar kennymccormick3 avatar rgdoliveira avatar sswitcher avatar x1ah avatar danielcorin avatar rarredon avatar sethwilsonus avatar grantfleming avatar siddardhaks avatar shivankar-madaan avatar dengelt avatar aswanipranjal avatar

Watchers

James Cloos avatar Ibrahim Yahya avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.