Skip to content

Webscraping service that provides definitions of a word or short phrase. Created for the DeerHacks Hackathon in April 2022 and earned 2nd place.

Notifications You must be signed in to change notification settings

hassanelsheikha/EssayBrainstormer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

EssayBrainstormer

This project was designed for the DeerHacks Hackathon (https://deerhacks.mcss.club/), and earned second-place in the UiPath automation category. View more at https://devpost.com/software/definiton-finder

Purpose

Our goal when creating EssayBrainstormer was to create a platform where anyone could provide a keyword, and the platform would handle the brainstorming process of writing on essay on said topic.

Implementation Overview

This program is implemented using Python as the back-end language. It leverages UiPath for automation and scraping data from Wikipedia (the definitions of terms as of the latest release). For front-end, Flask is used as the web framework.

Installation Prerequisites

-As of the time of this writing, this project is available for use only on machines running Windows as their OS, since UiPath does not support Linux- nor MacOS-based machines.

-The following must be installed on your machine:

  • At least Python 3.9
  • UiPath Studio
  • Internet Explorer (for the UiPath automation to work)
  • Python Packages: flask, pyperclip, dotenv, nltk, PyDictionary, itertools, GoogleNews

Usage

First, open up the .env file located in the main directory. Here you should see two lines:

uirobotpath = ""
processpath = ""

On your machine, search for the UiRobot.exe file, which is usually located in \AppData\Local\Programs\UiPath\Studio. Then, copy its complete path, and paste it in between the double quotes next to uipathrobot = in the .env file. Next, in the project directory on your machine, head to uipath\\WikiFetcher\\WikiFetcher\\Main.xaml. Once again, copy the absolute path, and paste it in between the quotes next to processpath in the .env file.

The __init__.py module in the main directory is the main module of this project. When run, the console should similar to the screenshot below:

image

Press the blue address, and a webpage identical to the one in the below screenshot should open in your default browser

image

Here, simply enter a topic into the text field, and after the process executes, the results should be visible on the webpage (as text).

NOTE: Browser links/windows may open during execution. This is normal! Please do not close the tabs/windows.

About

Webscraping service that provides definitions of a word or short phrase. Created for the DeerHacks Hackathon in April 2022 and earned 2nd place.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •