Feedback

README.md

@@ -1,3 +1,4 @@
+[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-24ddc0f5d75046c5622901739e7c5dd533143b0c8e959d652212380cedb1ea36.svg)](https://classroom.github.com/a/2OGTtL0Y)
 # Junior Seminar (CMPSC 580) Own Project Repository
 
 ## Semester: Spring 2024

requirements.txt

@@ -0,0 +1,5 @@
+beautifulsoup4==4.9.3
+nltk==3.8.1
+textblob==0.18.0
+# for finbert sentiment analysis
+# happytransformer==3.0.0

src/README.md

@@ -1,17 +1,26 @@
 # Project Prototype
 
-TODO: The result of your work will be the delivery of some type of proof-of-concept prototype which will likely contain software programming solutions (i.e., Python code, HTML pages, or similar). All source code for the prototype must be stored in this directory. If your prototype uses data, please create `data/` subdirectory in `src/` and include your data file(s) in `src/data/` directory.
-
-To allow the user to experience and execute your prototype, you must first explain how to set up the initial conditions to run or use the artifact. Be sure to offer explicit details and instructions regarding the installation of the necessary foundational libraries, drivers, external software projects, containers and similar types of tertiary software which are involved in executing your artifact. Once these initial software installations have been completed, then you are asked to offer the necessary instructions for actually executing the artifact. For this, please provide all command line parameters or associated bash commands for execution. Please remember that users are unwilling to "figure-out" how to use code in absence of the essential instructions concerning the execution of project artifacts.
-
 ## Key Features
 
-TODO: Outline the  main technical features of your prototype.
+The key feature of this prototype is performing sentiment analysis on the HTML files within the `data/corpus` folder. This prototype presents the user with the results of pre-trained models VADER, TextBlob, and finBERT.
 
 ## Requirements
 
-TODO: Include the software and hardware needed to run your prototype. Be sure to specify the  versions of software used in your prototype.
+The required software needed for the prototype are as follows:
+
+* Beautiful Soup v4.9.3
+* NLTK v3.8.1
+* TextBlob v0.18.0
+* Happy Transformer v3.0.0
+  * Needed for finBERT (curretly commented out)
 
 ## Using the Prototype
 
-TODO: Provide details for how to run your artifact. Include specific commands and step by step instructions.
+To run the prototype do the following:
+
+1. Clone the repository
+2. Navigate to the repository's directory
+3. Install the required dependencies by using the following command:
+    * `python -m pip install -r requirements.txt`
+4. Run the program using the following command:
+    * `python src/main.py`