Skip to content

Customizable personal assistant module to integrate in your own python scripts

License

Notifications You must be signed in to change notification settings

barleyj/Automata-pip

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Automata

Automata is a customized personal assistant module which can be integrated with your python scripts. You can easily plug your own modules with it and that's not even the best part :)

Installation

pip install python-automata

Usage

Example

from automata import automata

ob = automata.Automata()
res = ob.execute('What is the meaning of life?')

print res

Output

The answer to the ultimate question of life, the universe and everything is 42.

It has some pre defined modules like:

  1. Telling day, date and time
  2. Finding meaning of words
  3. Telling meaning of life for the lost souls

To develop your own module, follow the module development guide below.

Module dev guide

Below are some general guidelines for developing your own module:

  • The name of the python script should always start from mod_. Example mod_time.py
  • It should have a global list named KEYWORDS containing some keywords which will trigger this module. Example for the mod_time.py, the list is something like this KEYWORDS = ['what', 'time']
  • Every module should contain a method named run(query='') which will receive the input query. Example:
from datetime import datetime

KEYWORDS = ['what', 'date']

def run(query=''):
	return datetime.now().strftime("%Y:%m:%d")
  • The run(query='') should return the response generated by it which could be used for further processing.
  • Any processing of the input query should be done in the run(query='') method.
  • If you want to use your own modules then place them in a single folder and give the path to that folder while instantiating the Automata class. Example;
from automata import automata

ob = automata.Automata('/Users/testuser/modules')
res = ob.execute('What is the meaning of life?')

print res

Note: Contributions and suggestions are always invited

About

Customizable personal assistant module to integrate in your own python scripts

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages