diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 20a6f25..926366c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,22 +1,29 @@ -**Describe the bug** +# Describe the bug + A clear and concise description of what the bug is. -**To Reproduce** +## To Reproduce + Steps to reproduce the behavior: + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** +## Expected behavior + A clear and concise description of what you expected to happen. -**Screenshots** +## Screenshots + If applicable, add screenshots to help explain your problem. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Version [e.g. 22] +## Desktop (please complete the following information) + +- OS: [e.g. iOS] +- Version [e.g. 22] + +## Additional context -**Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 6e74a07..b09d7c4 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,11 +1,17 @@ -**Is your feature request related to a problem? Please describe.** +# Feature request + +## Is your feature request related to a problem? Please describe + A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -**Describe the solution you'd like** +## Describe the solution you'd like + A clear and concise description of what you want to happen. -**Describe alternatives you've considered** +## Describe alternatives you've considered + A clear and concise description of any alternative solutions or features you've considered. -**Additional context** +## Additional context + Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9a66332..b7d360e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,5 @@ # Description + Fixes # (issue) ## Type of change @@ -11,8 +12,7 @@ Please delete options that are not relevant. - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update - -# Checklist: +## Checklist - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code @@ -20,4 +20,4 @@ Please delete options that are not relevant. - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings -# ScreenShots (if any) +## ScreenShots (if any) diff --git a/Contributing.md b/Contributing.md index d4e8782..7dcde38 100644 --- a/Contributing.md +++ b/Contributing.md @@ -3,15 +3,20 @@ Developers are welcome to contribute to this project
Initial Step: Comment under the issue you want to work on and get the issue assigned to yourself.
-# Steps for contributing -## Fork this repository + +## Steps for contributing + +### Fork this repository + Fork the repo by clicking on the Fork option
-## Clone the repository + +### Clone the repository + Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the _copy to clipboard_ icon. Open a terminal and run the following git command: -``` +```bash git clone "url you just copied" ``` @@ -19,61 +24,61 @@ where "url you just copied" (without the quotation marks) is the url to this rep For example: -``` +```bash git clone https://github.com/YOUR-USERNAME/DesktopAssistant.git ``` where `YOUR-USERNAME` is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer. -## Create a branch +### Create a branch Change to the repository directory on your computer (if you are not already there): -``` +```bash Run `cd DesktopAssitant` ``` Now create a branch using the `git branch` command: -``` +```bash Run `git branch ` ``` + Here, you can try and keep branch name as the number of issue you are trying to solve i.e ```issue_1```
Checkout to the new branch so you can push onto the new branch of the forked repository -``` +```bash git checkout ``` - -## Make necessary changes and commit those changes +### Make necessary changes and commit those changes If you go to the project directory and execute the command `git status`, you'll see there are changes. Add those changes to the branch you just created using the `git add` command: -``` +```bash git add . ``` Now commit those changes using the `git commit` command: -``` +```bash git commit -m "anything that expresses whatever changes you have made" ``` -## Push changes to GitHub +### Push changes to GitHub Push your changes using the command `git push`: -``` +```bash git push origin ``` replacing `` with the name of the branch you created earlier. -## Submit your changes for review +### Submit your changes for review Now you are ready to make a pull request. Go to the forked repo on Github under your profile and a click on the ```Compare & pull request```button. You will be taken to a page where you can create a pull request. When creating a PR, add the linked issue in the description. For example : "Closes #1" if the issue you have resolved is issue #1 diff --git a/README.md b/README.md index 5c29b89..a569397 100644 --- a/README.md +++ b/README.md @@ -3,52 +3,65 @@ A Virtual Desktop Assistant Written in Python.
It's generally a basic virtual assistant
-The basic purpose of this is to make work easier as it re-directs you to various main sites and performs various important functions for your PC as well just install it for your system and run it in your code editor or IDE. I will be soon updating it as an application for MacOS, Linux and Windows. Until then you can follow the Contributing Guidelines and Contribute into this Desktop Assistant.
+The basic purpose of this is to make work easier as it re-directs you to various main sites and performs various important functions for your PC as well just install it for your system and run it in your code editor or IDE. I will be soon updating it as an application for MacOS, Linux and Windows. Until then you can follow the Contributing Guidelines and Contribute into this Desktop Assistant. -# Installing : +## Installing - Clone the repo to make it available on your local system by using ```git clone ``` - cd into the project directory i.e - ```cd DesktopAssitant``` +## Requirements for windows -# Requirements for windows Steps to run the Assistant on your pc (use python 3.9) Installing all the necessary python module using -``` + +```bash pip install -r requirements.txt -``` -# Dependency for Ubuntu ``` + +## Dependency for Ubuntu + +```bash sudo apt-get update ``` -``` + +```bash sudo apt-get install espeak ``` -``` + +```bash pip install -r ubuntu_requirements.txt ``` Wow All done! Now give the command to jarvis. -# Run -For windows user run -``` +## Run + +For windows user run + +```md python Jarvis2_4windows.py ``` -For ubuntu user run -``` + +For ubuntu user run + +```md python Jarvis2.py ``` -Wow! all done and now give some voice command -# Download - - For Windows users, download this [installer](https://raw.githubusercontent.com/Harsha200105/DesktopAssistant/issue_44/bin/jarvis%20desktop%20assistant%20setup.exe) - - For Ubuntu users, download this [deb package](https://raw.githubusercontent.com/Harsha200105/DesktopAssistant/issue_44/bin/jarvis_deb.deb). -# Contributing Guidelines :
+ +Wow! all done and now give some voice command + +## Download + +- For Windows users, download this [installer](https://raw.githubusercontent.com/Harsha200105/DesktopAssistant/issue_44/bin/jarvis%20desktop%20assistant%20setup.exe) +- For Ubuntu users, download this [deb package](https://raw.githubusercontent.com/Harsha200105/DesktopAssistant/issue_44/bin/jarvis_deb.deb). + +## Contributing Guidelines + - We are Open for Pull Requests - Please contribute and add value to the code - If you have some ideas for new features and you don't have time to implement them please open an issue with the tag new_feature. - Please don't forget to comment (document) your code! - Also If you feel like developing or working out on the Documentation section of this repository make sure to raise an issue regarding and i'll assign you that! - Before creating a Pull Request please go through the above guidelines and the code! - diff --git a/run.md b/run.md index 8615c25..651267e 100644 --- a/run.md +++ b/run.md @@ -1,30 +1,39 @@ -# How to run the program +# How to run the program Here are some installation Guidelines and procedure how you can execute the programme and use it for performing basic tasks: -## Table of Contents: +## Table of Contents -- [Check for `PIP` installation](#check-for-pip-installation) -- [Pyttsx3](#pyttsx3) -- [Speech Recognition](#speech-recognition) -- [Pygame
](#pygame-) -- [Suitable IDE for running this program](#suitable-ide-for-running-this-program) -- [Commands to interact with program.](#commands-to-interact-with-program) +- [How to run the program](#how-to-run-the-program) + - [Table of Contents](#table-of-contents) + - [Check for `PIP` installation](#check-for-pip-installation) + - [Pyttsx3](#pyttsx3) + - [Speech Recognition](#speech-recognition) + - [Pygame](#pygame-) + - [Suitable IDE for running this program](#suitable-ide-for-running-this-program) + - [Commands to interact with program](#commands-to-interact-with-program) ------------------------------------- -## Check for `PIP` installation + +## Check for `PIP` installation + - PIP is a tool that is used to install python packages. PIP is automatically installed with Python 2.7. 9+ and Python 3.4+. -- Open the command prompt and enter the below command to check whether pip is installed. +- Open the command prompt and enter the below command to check whether pip is installed. + ```md pip --version ``` + - If you are receiving an error, it means that you might be having `pip3` installed, so try this command. + ```md pip3 --version ``` + ```md python --version -``` +``` + > If you are still facing issues, try installing pip from [here](https://github.com/pypa/pip#readme) ## Pyttsx3 @@ -32,22 +41,26 @@ python --version - pyttsx3 is a text-to-speech conversion library in Python. Unlike alternative libraries, it works offline, and is compatible with both Python 2 and 3 - Open the command prompt/terminal and enter the below command to install `pyttsx3` + ```md pip install pyttsx3 ``` + > Visit the [Pyttsx3 documentation](https://pypi.org/project/pyttsx3/) to know more about this library. + ## Speech Recognition - SpeechRecognition is a library for performing speech recognition, with support for several engines and APIs, online and offline. -- Open the command prompt/terminal and enter the below command to install `SpeechRecognition` - +- Open the command prompt/terminal and enter the below command to install `SpeechRecognition` + ```md pip install pyaudio SpeechRecognition ``` + > Visit the [Speech Recognition documentation](https://pypi.org/project/SpeechRecognition/) to know more about this library. -## Pygame
+## Pygame - Pygame is a set of Python modules designed for writing video games. Pygame adds functionality on top of the excellent SDL library. This allows you to create fully featured games and multimedia programs in the python language. - Open the command prompt/terminal and enter the below command to install `Pygame` @@ -56,22 +69,23 @@ pip install pyaudio SpeechRecognition pip install pygame ``` -# Suitable IDE for running this program +## Suitable IDE for running this program - Desktop Assistant can be run in the following code editor IDEs. - - [Pycharm](https://www.jetbrains.com/help/pycharm/installation-guide.html) - - [Visual Studio Code](https://code.visualstudio.com/docs) - - [Jupyter-lab](https://jupyterlab.readthedocs.io/en/latest/) - - [Replit](https://docs.replit.com/) + - [Pycharm](https://www.jetbrains.com/help/pycharm/installation-guide.html) + - [Visual Studio Code](https://code.visualstudio.com/docs) + - [Jupyter-lab](https://jupyterlab.readthedocs.io/en/latest/) + - [Replit](https://docs.replit.com/) -# Commands to interact with program. +## Commands to interact with program After successful installation of the forementioned dependencies, you can use the following commands (speak out) to interact with Jarvis, your `Desktop-Assistant` -``` + +```md Start with : Hello Random Ans : How are you? : Google - : Youtube + : Youtube send email : Open email : Nothing : Abort