Skip to content

Repository files navigation

MyGuyAssistantAPI

MyGuyAssistantAPI is a Python-based API for a voice-activated assistant using the "my guy open me" wake word. It allows users to interact with their computer through voice commands, such as opening applications and performing basic tasks.

Table of Contents

Introduction

MyGuyAssistantAPI is built using Python and Flask, leveraging the Porcupine wake word engine for keyword detection. It provides a simple yet powerful interface for users to interact with their computer hands-free, making it ideal for tasks like opening applications, performing web searches, and more.

Features

  • Wake word detection using Porcupine
  • Integration with various applications (e.g., Calculator, Notepad, Browser)
  • Voice command recognition for opening applications
  • Support for custom voice commands and extensions

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/MyGuyAssistantAPI.git
  1. Install the dependencies:
pip install -r requirements.txt
  1. Download the Porcupine wake word model (my-guy-open--me_en_windows_v3_0_0.ppn) and place it in the project directory.

  2. Run the Flask app:

python myguy.py

Usage

To use the MyGuyAssistantAPI:

  1. Ensure that the Flask app is running.
  2. Send a POST request to the /api/wakeword endpoint to start listening for the wake word.
  3. Once the wake word is detected, follow the prompts to interact with the assistant.

Documentation

For detailed documentation and usage examples, refer to the Wiki.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to help improve the project.

License

This project is licensed under the MIT License.


Feel free to customize the README further based on your project's specific details and requirements.

About

Welcome to MyGuyAssistantAPI, an API-driven virtual assistant built with Python and Flask. This API allows users to interact with a virtual assistant by sending requests to trigger specific actions, such as opening applications or performing tasks based on voice commands.

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages