🖥️ Desktop Assistant

A simple voice-assisted desktop assistant made in Python. The assistant will have basic features supporting daily laptop usage.

Table of Contents

• 🖥️ Desktop Assistant
  • Table of Contents
  • 🚀 Introduction
  • ✨ Features
  • 🚀 Getting Started
    • 📋 Prerequisites
    • 🛠️ Installation
  • 🤝 Contributing
  • 🐞 Bug Reports and Feature Requests
  • 💬 Discussion Groups

🚀 Introduction

• A Python-based desktop assistant configured to automate some of the day-to-day tasks and help save time.
• Voice assistance is used to provide a hands-free interface to the user as the assistant can run in the background while performing day-to-day tasks.
• Extras.py and Support.py files are for having additional globally required variables, and query functions handling individual queries respectively.
• The VoiceInterface.py file contains the VoiceInterface class which handles the abstraction of user voice recognition and assistant speech.
• The Assistant.py file contains the main code integrating everything together to run the assistant properly.

✨ Features

• Google and Wikipedia searches 🌐
• Run applications or websites from a predefined map/list 🚀
• Tell time of the day in hour : minute : second format ⏰

🚀 Getting Started

• Fork or download the project.
• Install the Python dependencies mentioned in the requirements.txt file using pip or pip3.
• Run the main Python file named Assistant.py in the project root folder to run the assistant.

📋 Prerequisites

• The project is coded using Python 3.11.0, so it would be best to install an equivalent or later version.
• The modules required are listed in the requirements.txt file which can be installed as discussed below.

🛠️ Installation

1. Download and extract the zip file or clone the repository using the following command.

   git clone https://github.com/vihar-s1/Desktop-Assistant

2. In the project root directory run following commands to create a virtual environment, activate it, and install the python module dependencies.

   python -m venv .venv
   source .venv/Scripts/activate
   pip install -r requirements.txt

3. Once installed, simply run the Assistant.py file to start using the Assistant.

   python Assistant.py

🤝 Contributing

• If you want to contribute, follow the contribution guidelines here: Contributing Guidelines

• Create a virtual environment for contributing to prevent unnecessary packages from being included in the requirements.txt file while updating it via updateRequirementsFile.sh

python -m venv .venv
source .venv/Scripts/activate
pip install -r requirements.txt

• Make Sure to update the requirements.txt file by running updateRequirementsFile.sh in case any additional packages are installed.

bash updateRequirementsFile.sh

🐞 Bug Reports and Feature Requests

• If you encountered an issue or want to report a bug, following is the Bug Report Template you will be asked to follow.
• Any new feature requests will also appreciated if it follows the predefined Feature Request Template.

NOTE: The templates are predefined and integrated in the repository so you can easily go to the Issues Tab and start writing your bug report, or feature request without any problem.

💬 Discussion Groups

To discuss about the project in depth with the contributors of the project about new features, bug requests, or just suggestions, join the Matrix Space or go to the Discussion Page of the repository.