Skip to content

Latest commit

 

History

History
224 lines (160 loc) · 7.18 KB

README.md

File metadata and controls

224 lines (160 loc) · 7.18 KB

Walmart-Capstone-Project

Undergraduate Capstone project for the University of Arkansas department of Computer Science and Computer Engineering, 2021-2022 academic year.

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Walmart Social Media Sentiment Analysis Tool

We have built a tool to analyze sentiment across multiple social media platforms from Walmart associates by means of natural languge processing, machine learning, and data analysis techniques.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

To better understand our associates and the way they feel about the company, We need a way to gather data on what employees are saying about Walmart in an open-discussion environment. This tool will allow us to do so, gathering meaningful data while maintaining anonimity across the board.

(back to top)

Built With

(back to top)

Getting Started

To get started, simply follow the guide outlined below before making any changes.

Prerequisites

The year is 2022 and some of us are still acting like PyCharm isn't the best IDE for Python projects. I'm not upset, but rather confused. Download PyCharm if you don't know how to run this project otherwise.

Installation

  1. Clone the repo 
    git clone https://github.com/dsalaz04/Walmart-Capstone-Project
  2. Create and start a virtual environment to contain all packages 
    pip install virtualenv
cd my-project/
virtualenv venv
source venv/bin/activate
  3. Install requirements if you haven't already 
    pip install -r requirements.txt
  4. Configure either 'Reddit_Scraper.py' or 'Tweet_Crawler.py' to be your main script
  5. If using Twitter, enter your API key in config.js 
    const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

Work in Progress. We will add screenshots and usage descriptions here. This will be a section for usage based on the end user's perspective rather than the developer's perspective.

For more in depth usage, please refer to the Documentation

(back to top)

Roadmap

  • Define platforms to use: Twitter, Reddit
  • Define tags, types of posts to look for, etc.
  • Build UI to interact with tool
  • Extend code for higher ambiguity and resuability

See the open issues for a full list of proposed features.

(back to top)

Contributing

If you would like to contribute to the project after the Spring 2022 term, feel free to do so by opening a pull request:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/NewFeature)
  3. Commit your Changes (git commit -m 'Add NewFeature')
  4. Push to the Branch (git push origin feature/NewFeature)
  5. Open a Pull Request

(back to top)

License

Not distributed under any license, but please contact us for reuse.

(back to top)

Contact

Daniel - @dsalaz04 - [email protected]

Project Link: https://github.com/dsalaz04/Walmart-Capstone-Project

(back to top)

Acknowledgments

(back to top)