README

Author: DurgaSai-16

AutomationScripts/Wiki Bot/README.md

@@ -0,0 +1,88 @@
+# Wiki Bot🤖
+## Aim
+To create a Wikipedia Bot that listen our input, searches for output and reads it for us.
+## Purpose
+The purpose of Wikipedia Bot is to benefit user just by taking user's speech as input, searches for the topic and provides relevant output in the form of text as well as audio along with an image related to it.
+## Short Description
+- Bots are normally used to automate certain tasks, they can run without specific instructions from humans.
+- It'll be always nice to see something that makes our work simple,Instead searching for something in wikipedia by opening browser Wiki bot just asks what you want and gives all you want.
+- Wiki Bot is voice controlled bot that let's you to search and gather information within the Python IDE.
+- Wiki Bot browsesall the relevant information and speaks out about it briefly.
+- This also shows the related image of corresponding topic.
+- ***Libraries Imported:***
+    - `wikipedia`
+    - `datetime`
+    - `pyttsx3`
+    - `speech recoginition`
+    - `pyaudio`
+    - `urllib.request`
+    - `os`
+
+## Workflow
+
+- Import all the required libraries i.e., wikipedia, datetime, pyttsx3, speech recognition, pyaudio, urllib.request, os.
+- `wikipedia`
+    - ***Installation:***  `pip install wikipedia`
+    - ***Purpose:*** This used acess wikipedia easily
+- `datetime`
+    - ***Installation:***  It is Python's standard library.
+    - ***Purpose:*** For greeting user based on the date and time
+- `pyttsx3`
+    - ***Installation:***  `pip install pyttsx3`
+    - ***Purpose:*** Converts text to speech.
+- `speech recoginition`
+    - ***Installation:***  `pip install speechrecognition`
+    - ***Purpose:***  Used to convert our voice input to text.
+- `pyaudio`
+    - ***Installation:***  `pip install pyaudio`
+    - ***Purpose:***  Used to speak out the information gathered by bot from the wikipedia
+- `urllib.request`
+    - ***Installation:***  `pip3 install urllib3`
+    - ***Purpose:*** Here it is used for fetching and opening URLs.
+- `os`
+    - ***Installation:***  OS is python's standard library.
+    - ***Purpose:*** This provides functions for creating and removing a directory, fetching its contents, changing and identifying the current directory, etc.
+ - **NOTE:**   [Python Extension Packages](https://www.lfd.uci.edu/~gohlke/pythonlibs/#pyaudio)
+ <ins>
+
+</ins>
+
+```
+
+If you get any error while downloading and installing the required libraries
+Please visit above site and download whl file that supports your windows Version and then try to install it.
+```
+
+
+
+## Compilation Steps
+- Download the file [Wiki_Bot.py](https://github.com/DurgaSai-16/Awesome_Python_Scripts/blob/main/AutomationScripts/Wiki%20Bot/Wiki_Bot.py)
+- Run the file [Wiki_Bot.py](https://github.com/DurgaSai-16/Awesome_Python_Scripts/blob/main/AutomationScripts/Wiki%20Bot/Wiki_Bot.py)
+- Execution of code begins and Asks the topic you want.
+- You need speak out the topic you
+- Then, starts searching the topic in wikipedia.
+- Gathers relevant information to the topic and starts dictation.
+- If it show any error regarding libraries, download them as mentioned in workflow.
+- If it didn't recognise your voice. Please try to speak clearly.
+
+
+## Output
+![WikiBot_Abdul Kalam](https://user-images.githubusercontent.com/85128689/127784305-15f32f0c-bf44-4bfa-8eb1-526b7f8d9fb9.png)
+
+Image Pathlink: https://github.com/DurgaSai-16/Awesome_Python_Scripts/blob/main/AutomationScripts/Wiki%20Bot/Media/Images/Wiki_Bot%20Output_1.png
+
+https://user-images.githubusercontent.com/85128689/127961763-46105dd0-82cf-432a-b58e-df493d844511.mp4
+
+Video Pathlink: https://github.com/DurgaSai-16/Awesome_Python_Scripts/blob/main/AutomationScripts/Wiki%20Bot/Media/Videos/Wiki_Bot%20Output_1.mp4
+
+![image](https://user-images.githubusercontent.com/85128689/127967178-cbe74819-01ba-4e61-819b-686f56842647.png)
+
+
+Image Pathlink: https://github.com/DurgaSai-16/Awesome_Python_Scripts/blob/main/AutomationScripts/Wiki%20Bot/Media/Images/Wiki_Bot%20Output_2.png
+
+https://user-images.githubusercontent.com/85128689/127965524-b0dc2d77-d41b-4342-b103-1479cb7752bb.mp4
+
+Video Pathlink: https://github.com/DurgaSai-16/Awesome_Python_Scripts/blob/main/AutomationScripts/Wiki%20Bot/Media/Videos/Wiki_Bot_Output_2.mp4
+
+## Author:
+[NALLANI DURGA SAI](https://github.com/DurgaSai-16)