{"id":16078231,"url":"https://github.com/edouardpoitras/eva","last_synced_at":"2025-03-18T05:31:22.084Z","repository":{"id":137412826,"uuid":"78982760","full_name":"edouardpoitras/eva","owner":"edouardpoitras","description":"Open source voice-enabled personal assistant","archived":false,"fork":false,"pushed_at":"2017-02-09T23:57:26.000Z","size":1914,"stargazers_count":9,"open_issues_count":11,"forks_count":4,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-16T17:25:20.372Z","etag":null,"topics":["docker","eva","personal-assistant","plugins","python","text-to-speech","voice-commands","voice-recognition"],"latest_commit_sha":null,"homepage":"http://eva-core.readthedocs.io/en/latest","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/edouardpoitras.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-01-15T01:01:05.000Z","updated_at":"2023-05-21T16:28:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"df8e253e-72fc-4744-8e04-0571a53885f0","html_url":"https://github.com/edouardpoitras/eva","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edouardpoitras%2Feva","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edouardpoitras%2Feva/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edouardpoitras%2Feva/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edouardpoitras%2Feva/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/edouardpoitras","download_url":"https://codeload.github.com/edouardpoitras/eva/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244164957,"owners_count":20409016,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","eva","personal-assistant","plugins","python","text-to-speech","voice-commands","voice-recognition"],"created_at":"2024-10-09T10:09:15.040Z","updated_at":"2025-03-18T05:31:22.079Z","avatar_url":"https://github.com/edouardpoitras.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overview\n\n[![Documentation Status](https://readthedocs.org/projects/eva-core/badge/?version=latest)](http://eva-core.readthedocs.io/en/latest/?badge=latest)\n\nEva is an open source alternative to Amazon Echo or Google Home.\nThe core of Eva is a simple service that provides hooks for plugins during interactions with users. On it's own, Eva does very little. It's potential comes from the [plugins](https://github.com/edouardpoitras/eva-plugin-repository) the user chooses to enable (or create).\n\n# Installation\n\nIf you wish to use docker-compose to run Eva, ensure you have installed [Docker](https://docs.docker.com/engine/installation/) and the [docker-compose](https://docs.docker.com/compose/install/) utility.\n\nIf you wish to run Eva outside of Docker, install the required Python dependencies:\n\n```\n$ pip3 install -r requirements.txt\n```\n\nTODO: Allow for a proper pip install eva command.\n\n# First Steps\n\nTo run Eva with docker-compose, you simply have to run the following command:\n\n```\ndocker-compose up\n```\n\nOr, if running on an ARM-based device like the Raspberry Pi:\n\n```\ndocker-compose -f docker-compose-arm.yml up\n```\n\nThis may take a while on the first run as the Eva container is built and all the dependencies are installed.\n\nTo run Eva outside of Docker, you simply have to execute the `eva.directory.serve()` function. This is exactly what the `serve.py` does for you:\n\n```\npython3 serve.py\n```\n\nThe default setting for Eva is to install the [Web UI Plugins](https://github.com/edouardpoitras/eva-web-ui-plugins) and [Web UI Updater](https://github.com/edouardpoitras/eva-web-ui-updater) plugins (and their dependencies) on first startup. This behaviour can be changed by modifying the core Eva [configuration](https://eva-core.readthedocs.io/en/latest/configuration.html) file (typically found at `~/eva/eva.conf`).\n\nAlternatively, once Eva is started, you may navigate to the Web UI (https://localhost:8080) and enable/disable plugins as needed. Note that a self-signed certificate warning from your browser is normal at this point.\n\nWhile you're in the Web UI, you may as well download and enable the [Web UI Interact](https://github.com/edouardpoitras/eva-web-ui-interact) plugin which will allow you to test out Eva from the Web UI.\n\nWe discuss Eva clients more in depth on the [clients documentation](https://eva-core.readthedocs.io/en/latest/clients.html) page.\n\nAt this point Eva's capabilities are entirely controlled by the plugins enabled by the user. Try enabling the [echo](https://github.com/edouardpoitras/eva-echo) plugin and see if Eva echos back the commands you send it. Also try the [weather](https://github.com/edouardpoitras/eva-weather) plugin and ask Eva for the current forecast (you'll need to setup DarkSky API keys)\n\nNote: You will need to have enabled a voice recognition plugin if you wish to speak to Eva instead of using text commands.\n\nNote: You will need to enable a Text-to-Speech plugin if you wish to receive spoken words from Eva as a response.\n\n# Plugin Development\n\nPlease see the [plugin development guide](https://eva-core.readthedocs.io/en/latest/plugin_development.html) for more information on how to make Eva awesome (hint: it's easy). Also check out the source code of some of the plugins mentioned in this README.\n\n# Disclaimer\n\nEva is still a VERY young project. Please help us make it better by submitting feature requests and [issues](https://github.com/edouardpoitras/eva/issues) when discovered.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedouardpoitras%2Feva","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedouardpoitras%2Feva","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedouardpoitras%2Feva/lists"}