├── requirements.txt ├── install_raspberry_pi_requirements.sh ├── karen ├── utils │ ├── settings.py │ ├── voice.py │ └── setup.py ├── status.py ├── config_manager.py ├── Karen.py └── addon_manager.py ├── .gitignore ├── README.md └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | gTTS 2 | googletrans==4.0.0-rc1 3 | python-vlc 4 | pyaudio 5 | SpeechRecognition 6 | -------------------------------------------------------------------------------- /install_raspberry_pi_requirements.sh: -------------------------------------------------------------------------------- 1 | echo "Installing dependencies" 2 | sudo apt-get install flac 3 | sudo apt-get install git 4 | sudo apt-get install portaudio19-dev 5 | sudo apt-get instal vlc -------------------------------------------------------------------------------- /karen/utils/settings.py: -------------------------------------------------------------------------------- 1 | from utils.setup import load_config 2 | 3 | CONFIG_FILE = "config.json" 4 | 5 | 6 | def get_addon_settings(addon_name: str) -> dict: 7 | """ 8 | get settings for a specified addon 9 | 10 | addon_name: the name of the addon 11 | """ 12 | 13 | addon_settings = None 14 | addons = load_config(CONFIG_FILE)["addons"] 15 | 16 | for addon in addons: 17 | if addon_name == addon["name"]: 18 | addon_settings = addon["settings"] 19 | break 20 | 21 | return addon_settings 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # Distribution / packaging 7 | .Python 8 | build/ 9 | develop-eggs/ 10 | dist/ 11 | downloads/ 12 | eggs/ 13 | .eggs/ 14 | lib/ 15 | lib64/ 16 | parts/ 17 | sdist/ 18 | var/ 19 | wheels/ 20 | *.egg-info/ 21 | .installed.cfg 22 | *.egg 23 | MANIFEST 24 | 25 | # Environments 26 | .env 27 | .venv 28 | env/ 29 | venv/ 30 | ENV/ 31 | env.bak/ 32 | venv.bak/ 33 | 34 | # Karen response 35 | ./response.mp3 36 | 37 | # Karen addons 38 | addons/ 39 | 40 | # Karen config 41 | ./config.json 42 | 43 | # nohup log 44 | ./nohup.out -------------------------------------------------------------------------------- /karen/status.py: -------------------------------------------------------------------------------- 1 | from subprocess import Popen, PIPE 2 | import argparse 3 | 4 | """ 5 | get voice assistant status 6 | """ 7 | 8 | 9 | def is_online() -> bool: 10 | """ 11 | check if voice assistant is online 12 | """ 13 | 14 | is_online = False 15 | 16 | process = "karen.py" 17 | instance = "python" 18 | 19 | proc1 = Popen(["ps", "auxf"], stdout=PIPE) 20 | proc2 = Popen( 21 | ["grep", process], 22 | stdin=proc1.stdout, 23 | stdout=PIPE, 24 | stderr=PIPE, 25 | ) 26 | 27 | proc1.stdout.close() 28 | out, err = proc2.communicate() 29 | 30 | for line in out.decode("utf8").splitlines(): 31 | line = line.lower() 32 | if instance in line and process in line: 33 | is_online = True 34 | 35 | return is_online 36 | 37 | 38 | if __name__ == "__main__": 39 | parser = argparse.ArgumentParser(description="check status") 40 | parser.add_argument( 41 | "--online", 42 | "-o", 43 | action="store_true", 44 | help="check active/online status", 45 | ) 46 | 47 | args = parser.parse_args() 48 | 49 | if args.online: 50 | print(is_online()) -------------------------------------------------------------------------------- /karen/utils/voice.py: -------------------------------------------------------------------------------- 1 | import vlc 2 | 3 | from gtts import gTTS 4 | from googletrans import Translator 5 | from utils import setup 6 | 7 | 8 | class Voice: 9 | """ 10 | voice instance to handle responses and media using vlc bindings 11 | """ 12 | 13 | def __init__(self, config_file_path: str): 14 | """ 15 | config_file_path: main (global) config file 16 | """ 17 | 18 | self.config_file_path = config_file_path 19 | self.vlc_instance = vlc.Instance("--no-video") 20 | self.player = self.vlc_instance.media_player_new() 21 | 22 | def say(self, voice_output: str, lang: str = "en", translate: bool = True): 23 | """ 24 | say a response 25 | 26 | voice_output: the response 27 | lang: 639-1 language code for response (default: en) 28 | translate: option to translate response using google translate 29 | (default: true) 30 | """ 31 | 32 | settings = (setup.load_config(self.config_file_path))["settings"] 33 | 34 | if translate: 35 | translator = Translator() 36 | voice_output = translator.translate( 37 | voice_output, dest=settings["lang"] 38 | ).text 39 | 40 | tts = gTTS(voice_output, lang=settings["lang"]) 41 | tts.save("response.mp3") 42 | 43 | media = self.vlc_instance.media_new("response.mp3") 44 | 45 | self.player.set_media(media) 46 | self.player.play() 47 | 48 | def play_media(self, media_path: str): 49 | """ 50 | play media 51 | 52 | media_path: the path of media to pay/stream 53 | """ 54 | 55 | media = self.vlc_instance.media_new(media_path) 56 | media.get_mrl() 57 | self.player.set_media(media) 58 | self.player.play() 59 | 60 | def pause(self): 61 | """ 62 | pause media 63 | """ 64 | 65 | self.player.pause() 66 | 67 | def stop(self): 68 | """ 69 | stop media 70 | """ 71 | 72 | self.player.stop() 73 | -------------------------------------------------------------------------------- /karen/config_manager.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | import json 3 | 4 | from utils.setup import load_config 5 | 6 | """ 7 | manage main (global) config file 8 | """ 9 | 10 | CONFIG_FILE = "config.json" 11 | 12 | 13 | def write_config(config_file_path: str, config: dict): 14 | """ 15 | save config changes by writing to the config file 16 | """ 17 | 18 | with open(config_file_path, "w") as config_file: 19 | json.dump(config, config_file, indent=2) 20 | 21 | 22 | def update_addon_setting( 23 | addon_name: str = "", 24 | developer_name: str = "", 25 | setting_name: str = "", 26 | setting_value: str = "", 27 | ): 28 | 29 | """ 30 | update addon setting 31 | 32 | addon_name: name of addon for which to update it's settings 33 | developer_name: name of addon developer 34 | setting_name: name of the setting to update 35 | setting_value: value for setting 36 | """ 37 | 38 | config = load_config(CONFIG_FILE) 39 | 40 | for index in range(len(config["addons"])): 41 | if config["addons"][index]["name"] == addon_name: 42 | config["addons"][index]["settings"][setting_name] = setting_value 43 | break 44 | 45 | # save changes 46 | write_config(CONFIG_FILE, config) 47 | 48 | 49 | if __name__ == "__main__": 50 | parser = argparse.ArgumentParser(description="config manager") 51 | parser.add_argument( 52 | "--addon", 53 | "-a", 54 | help="update addon by name", 55 | ) 56 | parser.add_argument( 57 | "--developer", 58 | "-d", 59 | help="addon developer", 60 | ) 61 | parser.add_argument( 62 | "--setting", 63 | "-s", 64 | help="addon setting", 65 | ) 66 | parser.add_argument( 67 | "--value", 68 | "-v", 69 | help="value for update", 70 | ) 71 | 72 | args = parser.parse_args() 73 | 74 | if args.addon: 75 | if not args.setting: 76 | parser.error("addon requires setting (--setting, -s)") 77 | elif not args.developer: 78 | parser.error("addon requires developer (--developer, -d)") 79 | elif not args.value: 80 | parser.error("setting update requrires value (--value, -v)") 81 | 82 | update_addon_setting( 83 | addon_name=args.addon, 84 | developer_name=args.developer, 85 | setting_name=args.setting, 86 | setting_value=args.value, 87 | ) -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Click [here](https://www.youtube.com/watch?v=VPdPOVL8c1Q&list=PL9gEr35J45czlRLHXhA3jShGG_jIrRprJ) to see the video series for how Karen was made. 2 | 3 | ![Karen](https://github.com/AlfredoSequeida/KarenBackend/blob/main/karen/static/karen/img/karen_small.png) 4 | ### open source voice assistant 5 | 6 | Note: The Karen website containing the API and docs is no longer up, I have made the website codebase available [here](https://github.com/AlfredoSequeida/KarenBackend) 7 | 8 | ![demo](https://imgur.com/skUVfLH.gif) 9 | 10 | ## Installing 11 | Karen is a standalone Python program, which means that it runs like any other Python program or script. Python 3.5 or newer is required. 12 | 13 | 1) Clone or download this repository 14 | 2) Install the python dependencies using pip 15 | ``` 16 | pip3 install -r requirements.txt 17 | ``` 18 | 4) Install the system dependencies. If you want to deploy this on a Raspberry Pi system or a similar Debian distribution, the install_raspberry_pi_requirements.sh file is included to make this easier. 19 | ``` 20 | sudo install_raspberry_pi_requirements.sh 21 | ``` 22 | 3) Run Karen 23 | ``` 24 | python3 Karen.py 25 | ``` 26 | 27 | ## configuring 28 | Karen can be configured via the `config.json` file in Karen's root directory. The config file will be automatically created during Karen's initial run. Below is an example of the config file: 29 | 30 | ``` 31 | { 32 | "settings": { 33 | "names": [ 34 | "karen", 35 | "kevin" 36 | ], 37 | "lang": "en" 38 | }, 39 | "addons": [] 40 | } 41 | ``` 42 | Karen has a few configurable settings: 43 | 44 | `names` [array of strings]: A list of names that will be used as the trigger word to activate the voice assistant. 45 | 46 | `lang` [string]: The ISO 639-1 language code to be used. This is powered by Google translate. 47 | 48 | `addons` [array of objects]: The addons setting is where you will find all your installed add-ons. This setting is automatically populated by Karen at run time, which means that every time you install a new add-on, Karen must be restarted. This is also where you can configure the settings for a specific add-on if an add-on you have installed supports user settings. 49 | 50 | ## Add-ons 51 | ![addon demo](https://imgur.com/kkeyhaz.gif) 52 | 53 | The functionality for Karen comes from its add-ons, which are Python programs specifically made for use with Karen. [Karen has an add-on repository with add-ons available for you to install ](https://alfredo.lol/karen/). All of the add-ons in this repository are open source and are made by Karen's community. 54 | 55 | Add-ons can be installed manually, using Karen's add-on manager, or via the [Karen](https://github.com/AlfredoSequeida/karen-app) app. For more information on creating and installing add-ons, you can [read the documentation](https://alfredo.lol/karen/docs/0.0.1). 56 | 57 | ## More 58 | As mentioned before, [Karen also has a mobile app](https://github.com/AlfredoSequeida/karen-app) that can be used to install and configure add-ons. This mobile app is also open source and cross-platform (IOS & Android) made using React Native. 59 | 60 | If you want to deploy Karen on a raspberry pi and create an enclosure for it, [open source stl and openSCAD files for 3D printing are available](https://github.com/AlfredoSequeida/karen-model). 61 | -------------------------------------------------------------------------------- /karen/utils/setup.py: -------------------------------------------------------------------------------- 1 | import json 2 | import os 3 | import subprocess 4 | import sys 5 | 6 | 7 | def create_config(): 8 | """ 9 | create config file if it does not exist 10 | """ 11 | 12 | config_file = "config.json" 13 | 14 | default_config = { 15 | "settings": {"names": ["karen", "kevin"], "lang": "en"}, 16 | "addons": [], 17 | } 18 | 19 | if not os.path.exists(config_file): 20 | with open(config_file, "w") as config: 21 | json.dump(default_config, config) 22 | 23 | 24 | def load_config(config_file_path: str) -> dict: 25 | """ 26 | load json 27 | config_file_path: the file path of the config file 28 | """ 29 | 30 | config_dict = None 31 | 32 | with open(config_file_path) as config: 33 | config_dict = json.load(config) 34 | 35 | return config_dict 36 | 37 | 38 | def check_global_config(config_path: str): 39 | """ 40 | simple check for the main (global) json config file to check for some 41 | requeired settings 42 | 43 | config_path: the file path of the config file 44 | """ 45 | 46 | config = load_config(config_path) 47 | required_settings = ["names", "lang"] 48 | 49 | for setting in required_settings: 50 | if setting not in config["settings"]: 51 | print(f"Required setting '{setting}' missing from config") 52 | exit() 53 | 54 | 55 | def check_addon_config(config: dict): 56 | """ 57 | simple check for an addon json config file to check for some 58 | requeired settings 59 | 60 | config: the addon config 61 | """ 62 | 63 | addon_name = config["name"] 64 | valid_keys = [ 65 | "name", 66 | "commands", 67 | "entry-point", 68 | "languages", 69 | "required_packages", 70 | "settings", 71 | "version", 72 | "developer", 73 | "upstream", 74 | ] 75 | 76 | for key in config: 77 | if key not in valid_keys: 78 | print(f"invalid key '{key}' in {addon_name}'s config") 79 | exit() 80 | 81 | 82 | def get_addon_configs(addons_dir: str) -> list: 83 | """ 84 | get all the addon configs 85 | 86 | addons_dir: the directory where addons are stored 87 | """ 88 | 89 | return [ 90 | load_config(os.path.join(subdir, file)) 91 | for subdir, dirs, files in os.walk(addons_dir) 92 | for file in files 93 | if file == "config.json" 94 | ] 95 | 96 | 97 | def append_to_config( 98 | config_file_path: str, config_append: dict, key_name: str 99 | ): 100 | """ 101 | append data to config file 102 | 103 | config_file_path: the path for the config file 104 | config_append: the setting to append to a config file 105 | key_name: the name of the config setting 106 | """ 107 | 108 | config = load_config(config_file_path) 109 | config[key_name] = config_append 110 | 111 | with open(config_file_path, "w") as config_file: 112 | json.dump(config, config_file, indent=2) 113 | 114 | 115 | def load_addons(config_file_path: str, addons_dir: str): 116 | """ 117 | load addons to main config 118 | 119 | config_file_path: the main config file to load the addons to 120 | addons_dir: the directory where addons are store 121 | """ 122 | 123 | addon_configs = get_addon_configs(addons_dir) 124 | 125 | # update addon settings if necessary 126 | config = load_config(config_file_path) 127 | 128 | for installed_addon in config["addons"]: 129 | try: 130 | for setting_key, setting_value in installed_addon[ 131 | "settings" 132 | ].items(): 133 | for addon_index in range(len(addon_configs)): 134 | if ( 135 | addon_configs[addon_index]["name"] 136 | == installed_addon["name"] 137 | ): 138 | 139 | addon_configs[addon_index]["settings"][ 140 | setting_key 141 | ] = setting_value 142 | except: 143 | pass 144 | 145 | append_to_config(config_file_path, addon_configs, "addons") 146 | -------------------------------------------------------------------------------- /karen/Karen.py: -------------------------------------------------------------------------------- 1 | import speech_recognition as sr 2 | 3 | from utils import setup 4 | from utils.voice import Voice 5 | 6 | CONFIG_PATH = "config.json" 7 | ADDONS_DIR = "addons" 8 | 9 | 10 | class Karen: 11 | 12 | """ 13 | main Karen instance 14 | """ 15 | 16 | def __init__(self, config_file_path: str = CONFIG_PATH): 17 | """ 18 | config_file_path: file path for config file 19 | """ 20 | 21 | self.config_file_path = config_file_path 22 | 23 | self.setup() 24 | 25 | self.config = setup.load_config(self.config_file_path) 26 | self.settings = self.config["settings"] 27 | 28 | self.recognizer = sr.Recognizer() 29 | self.microphone = sr.Microphone() 30 | self.names = self.settings["names"] 31 | 32 | # voice intance 33 | self.voice_instance = Voice(self.config_file_path) 34 | 35 | def setup(self): 36 | """ 37 | setting up Karen 38 | """ 39 | 40 | # create config file 41 | setup.create_config() 42 | 43 | # check config global file 44 | setup.check_global_config(self.config_file_path) 45 | 46 | # load addons 47 | setup.load_addons(self.config_file_path, ADDONS_DIR) 48 | 49 | def parse_args(self, command: str, keyword: str) -> list: 50 | """ 51 | parse command arguments 52 | 53 | command: the command to parse 54 | keyword: the keyword that activated the command 55 | 56 | example: play song_name 57 | using keyword: play 58 | returns: [song_name] 59 | 60 | another example: play song_name by artist 61 | using keyword: play 62 | returns: [song_name, by, artist] 63 | """ 64 | 65 | command_without_keywords = command.replace(keyword, "").strip() 66 | return command_without_keywords.split() 67 | 68 | def execute_command(self, command: str): 69 | """ 70 | execute user command 71 | 72 | command: the command to execute 73 | """ 74 | 75 | print(f"Executing {command}") 76 | command_executed = False 77 | addons = self.config["addons"] 78 | 79 | # match command to addon 80 | for addon in addons: 81 | for command_to_listen_for in addon["commands"]: 82 | if command_to_listen_for in command: 83 | 84 | addon = __import__( 85 | f"{ADDONS_DIR}.{addon['developer']}_{addon['name']}.{addon['entry-point']}", 86 | fromlist=["addons"], 87 | ) 88 | 89 | # any possible errors should be handeled by developers 90 | # within their addons, if an error is encountered, they 91 | # will be ignored as to not halt/break the main instance 92 | try: 93 | addon.run( 94 | command_to_listen_for, 95 | self.parse_args(command, command_to_listen_for), 96 | self.voice_instance, 97 | ) 98 | except: 99 | pass 100 | 101 | command_executed = True 102 | 103 | if not command_executed: 104 | self.voice_instance.say("Sorry, I didn't understand that") 105 | 106 | def parse_command(self, voice_input: str) -> str: 107 | """ 108 | get command from user voice input 109 | 110 | voice_input: the user input as text 111 | """ 112 | 113 | command = "" 114 | 115 | # check for name keyword 116 | for name in self.names: 117 | if name in voice_input: 118 | command = voice_input.split(name)[1].strip() 119 | else: 120 | print(f"{name} has not been called") 121 | 122 | return command 123 | 124 | def run(self): 125 | """ 126 | run instance 127 | """ 128 | 129 | try: 130 | while True: 131 | # adjusting for ambient noise 132 | with self.microphone as source: 133 | self.recognizer.adjust_for_ambient_noise(source) 134 | print("Say something!") 135 | audio = self.recognizer.listen(source) 136 | 137 | print("Got it! Now to recognize it...") 138 | try: 139 | # recognize speech using Google Speech Recognition 140 | voice_input = str( 141 | self.recognizer.recognize_google( 142 | audio, language=self.settings["lang"] 143 | ) 144 | ).lower() 145 | 146 | # we need some special handling here to correctly print unicode characters to standard output 147 | print(f"You said {voice_input}") 148 | 149 | command = self.parse_command(voice_input) 150 | 151 | if command: 152 | self.execute_command(command) 153 | 154 | except sr.UnknownValueError: 155 | print("Oops! Didn't catch that") 156 | except sr.RequestError as e: 157 | print( 158 | "Uh oh! Couldn't request results from Google Speech Recognition service; {0}".format( 159 | e 160 | ) 161 | ) 162 | except KeyboardInterrupt: 163 | pass 164 | 165 | 166 | if __name__ == "__main__": 167 | karen = Karen() 168 | karen.run() -------------------------------------------------------------------------------- /karen/addon_manager.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | import sys 3 | import os 4 | import json 5 | import re 6 | from subprocess import run, Popen, PIPE, check_output, check_call 7 | 8 | from utils.setup import load_config, append_to_config, get_addon_configs 9 | 10 | 11 | """ 12 | manage addons for Linux system installations 13 | """ 14 | 15 | DOWNLOAD_LOCATION = "/tmp" 16 | DOWNLOAD_DIR = "karen_addon" 17 | ADDONS_DIR = "addons" 18 | 19 | 20 | def github_url_is_valid(github_url: str) -> bool: 21 | """ 22 | validate github project urls using regex 23 | 24 | github_url: the github project url 25 | """ 26 | 27 | valid = False 28 | 29 | match = re.search( 30 | "^(https)(:\/\/)(github.com)[\/:]([^\/:]+)\/(.+)$", github_url 31 | ) 32 | 33 | if match: 34 | valid = True 35 | 36 | return valid 37 | 38 | 39 | def git_clone(github_url: str): 40 | """ 41 | clone github projects uisng git clone 42 | 43 | github_url: the github project url 44 | """ 45 | 46 | if github_url_is_valid(github_url): 47 | 48 | # remove existing addon to avoid conflicts with git clone 49 | run(["rm", "-r", "-f", f"{DOWNLOAD_LOCATION}/{DOWNLOAD_DIR}"]) 50 | 51 | # download github project to tmp directory 52 | run( 53 | [ 54 | "git", 55 | "clone", 56 | github_url, 57 | f"{DOWNLOAD_LOCATION}/{DOWNLOAD_DIR}", 58 | ] 59 | ) 60 | 61 | 62 | def get_installed_python_packages() -> list: 63 | """ 64 | get all currently installed python packages 65 | """ 66 | 67 | packages_output = check_output([sys.executable, "-m", "pip", "freeze"]) 68 | 69 | return [ 70 | package.split("==")[0] 71 | for package in packages_output.decode("utf-8").splitlines() 72 | ] 73 | 74 | 75 | def install_python_package(package: str): 76 | """ 77 | install PyPi packages using pip 78 | 79 | package: the package name 80 | """ 81 | 82 | run([sys.executable, "-m", "pip", "install", package]) 83 | 84 | 85 | def install_required_packages(required_packages: list): 86 | """ 87 | install addon required packages 88 | 89 | required_packages: the requried packages 90 | """ 91 | installed_packages = get_installed_python_packages() 92 | 93 | for required_package in required_packages: 94 | # if package is not installed, then install that package 95 | if required_package not in installed_packages: 96 | install_python_package(required_package) 97 | 98 | 99 | def add_upsteam_to_config(github_url: str, addon_package: str): 100 | """ 101 | add upsteam url to addon config for reference 102 | 103 | github_url: the upstream github project url 104 | addon_package: the full pakcage identifier ('{developer}_{addon name}') 105 | """ 106 | 107 | append_to_config( 108 | f"{ADDONS_DIR}/{addon_package}/config.json", github_url, "upstream" 109 | ) 110 | 111 | 112 | def create_addons_dir(): 113 | """ 114 | create addons directory if it does not exists 115 | """ 116 | 117 | if not os.path.exists(ADDONS_DIR): 118 | os.makedirs(ADDONS_DIR) 119 | 120 | 121 | def install_addon(config: dict, addon_package: str): 122 | """ 123 | installing addon 124 | 125 | config: the downloaded addon config 126 | addon_package: the full pakcage identifier ('{developer}_{addon name}') 127 | """ 128 | 129 | create_addons_dir() 130 | 131 | # recreate the project sturcture based on the app's config file to 132 | # minimize errors with project sturcture 133 | 134 | # install any required dependencies 135 | if "required_packages" in config: 136 | install_required_packages(config["required_packages"]) 137 | 138 | try: 139 | run(["mkdir", f"{ADDONS_DIR}/{addon_package}"]) 140 | except: 141 | pass 142 | 143 | run(f"mv {download_location}/* {ADDONS_DIR}/'{addon_package}'", shell=True) 144 | 145 | 146 | def uninstall_python_package(package: str): 147 | """ 148 | uninstall python package using pip 149 | 150 | package: the PyPi package name to uninstall 151 | """ 152 | 153 | run([sys.executable, "-m", "pip", "uninstall", "-y", package]) 154 | 155 | 156 | def uninstall_required_packages(config: dict): 157 | """ 158 | uninstall addon required packages using pip 159 | 160 | config: addon config 161 | """ 162 | 163 | if "required_packages" in config: 164 | required_packages = config["required_packages"] 165 | 166 | for required_package in required_packages: 167 | uninstall_python_package(required_package) 168 | 169 | 170 | def uninstall_addon( 171 | name: str = "", 172 | developer: str = "", 173 | uninstall_requirements: bool = False, 174 | config: dict = {}, 175 | ): 176 | """ 177 | uninstall addon required packages using pip 178 | 179 | config: addon config 180 | """ 181 | 182 | # remove required packages 183 | if uninstall_requirements: 184 | uninstall_required_packages(config) 185 | 186 | # uninstall an addon by removing its directory 187 | run(["rm", "-r", "-f", f"{ADDONS_DIR}/{developer}_{name}"]) 188 | 189 | 190 | def restart(): 191 | """ 192 | restart voice assitant instance as background process using nohup 193 | """ 194 | 195 | process = "Karen.py" 196 | instance = "python" 197 | 198 | proc1 = Popen(["ps", "auxf"], stdout=PIPE) 199 | proc2 = Popen( 200 | ["grep", process], 201 | stdin=proc1.stdout, 202 | stdout=PIPE, 203 | stderr=PIPE, 204 | ) 205 | 206 | proc1.stdout.close() # Allow proc1 to receive a SIGPIPE if proc2 exits. 207 | out, err = proc2.communicate() 208 | 209 | proc = None 210 | 211 | for line in out.decode("utf8").splitlines(): 212 | if instance in line and process in line: 213 | proc = line.split() 214 | break 215 | 216 | try: 217 | # killing process by pid 218 | run(["kill", proc[1]]) 219 | except: 220 | pass 221 | 222 | # restart process 223 | Popen(["nohup", "python3", "Karen.py"]) 224 | 225 | 226 | if __name__ == "__main__": 227 | parser = argparse.ArgumentParser(description="addon manager") 228 | parser.add_argument( 229 | "-i", 230 | "--install", 231 | help="install addon using github url", 232 | ) 233 | parser.add_argument( 234 | "-u", 235 | "--uninstall", 236 | help="uninstall addon by name", 237 | ) 238 | parser.add_argument( 239 | "--developer", 240 | "-d", 241 | help="addon developer", 242 | ) 243 | parser.add_argument( 244 | "--requirements", 245 | "-r", 246 | action="store_true", 247 | default=False, 248 | help="uninstall addon requirements/dependencies", 249 | ) 250 | 251 | args = parser.parse_args() 252 | 253 | if args.install: 254 | # removing .git from url if it exists 255 | args.install = args.install.replace(".git", "") 256 | 257 | try: 258 | git_clone(args.install) 259 | 260 | download_location = f"{DOWNLOAD_LOCATION}/{DOWNLOAD_DIR}" 261 | config = load_config(f"{download_location}/config.json") 262 | 263 | # setting package name 264 | 265 | # in order to decrease the posibility of dupliates, addons packages 266 | # follow this naming convention when installing 267 | # 'developer.addon name' 268 | 269 | # since "." in python is used to package directories, they are replaced 270 | # with underscores 271 | 272 | addon_package = ( 273 | f"{config['developer'].replace('.', '_')}_{config['name']}" 274 | ) 275 | 276 | install_addon(config, addon_package) 277 | add_upsteam_to_config(args.install, addon_package) 278 | except: 279 | pass 280 | finally: 281 | restart() 282 | 283 | elif args.uninstall: 284 | # checks for mutually inclusive args 285 | if not args.developer: 286 | parser.error("uninstall requires developer (--developer , -d)") 287 | 288 | addons = get_addon_configs(ADDONS_DIR) 289 | config = None 290 | 291 | for addon in addons: 292 | if addon["name"] == args.uninstall: 293 | config = addon 294 | break 295 | 296 | uninstall_addon( 297 | name=args.uninstall, 298 | developer=args.developer, 299 | uninstall_requirements=args.requirements, 300 | config=config, 301 | ) 302 | 303 | restart() -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------