StockEye

Version: 1.4
Release Date: Feburary 12, 2021
Last Updated: March 25, 2021
Authors: Michael Okenye, Jeff Kolnick, Anshul Khatri, Perikles Tsikrikis
Editors: Campbell Leckie, Nicolas Mills, Ruth Schmidt, Roy Ceyleon

(1.1) Project Summary

StockEye is a web application that aggregates and analyses tweets related to the stock market from the popular social media platform Twitter, and offers information regarding the public sentiments of stocks and volume metrics to its users. StockEye seeks to serve its audience in multiple ways. For one, Twitter is a valuable source of data, as it currently acts as a hub for global public opinion. Due to the impact that public opinion has on the market, the analysis of Twitter data presented by StockEye enables its users to make more informed investment decisions. Additionally, StockEye will save users time, as they will no longer be required to research and analyse the Twitter sentiments themselves.

(1.2) Purpose

This document covers all the software requirements and features for the StockEye application, and is primarily intended for the client (David Brown), the project team, and other interested parties, both present and future. It will ensure that all necessary components are included and serve as a basis for the project.

(1.3) Scope

This project will produce the web application StockEye. This product will assess the intent of tweets as well as tweet volume regarding stocks chosen by its users and compile and present them in an easily comprehensible format. It will thus give an immediate overview of their Watchlist and allow for quick decision making as the market may dictate without having to scour Twitter for the relevant information.

(1.4) Definitions & Abbreviations

Term	Definition
API	Application Program Interface
GUI	Graphical User Interface
IaaS	Infrastructure as a Service
Popular Stocks	Trending stocks with either positive or negative sentiments.
SRS	StockEye Software Requirements Specification document
The Client	David Brown
Tweet	A post made on the Twitter social network.
Tweet Volume	The amount of tweets made within a specific time frame.
Tweepy	An open source Python package which allows access to the Twitter’s API with Python.
Twitter Sentiment	The attitude, thought or feeling indicated by a tweet.
User	The person, or persons, who operate or interact directly with the application.
Watchlist	List of stock monitored by a user for potential investment opportunities.
Tester	A member of the Quality Assurance team for a specific deliverable.

(1.5) References

A complete list of all documents and other sources of information referenced.

• IEEE Recommended Practice for Software Requirements Specifications (1998)
• CP317: Samples
• CP317 Notes: Requirements
• Twitter Sentiment Visualization

(1.6) Overview

This document contains all functional requirements for the StockEye web application. It details how the product will operate, its limitations and projected user base. It first establishes the context in which StockEye is being formulated and subsequently identifies the essential features for it to be a success.

(2.1) Product Perspective

StockEye builds directly off of Twitter, utilizing the Tweepy API. Through this it will be able to import tweets and assemble it into data to help inform its users of potential rises and falls in the stocks they are most interested in.

(2.2) Product Functions

• Interpret tweets.
• Aggregate sentiment data - tracks rise and fall of a particular stock.
• Track volume of tweets associated with intended stocks within a specific timeframe.
• Allow user choice of interested stocks.
• Easy-to-follow organizational structure.

(2.3) User Characteristics

• Shareholder (current or potential)
• Savvy (tech and financial)
• Financial interest
• Familiarity with social media

(2.4) Constraints

• Time - to be completed no later than April 12, 2021.
• Tools limited to that which are freely available.
• Inexperience and unfamiliarity with the prerequisite technologies demanded by the objectives of the application.
• Limited communication capability due to COVID-19 pandemic restrictions.

(2.5) Assumptions and Dependencies

• Deliverables will be completed by several team members; this includes writers and testers.
• Deliverables will be reviewed by the entire team, following approval by the quality assurance team assigned to the respective deliverable.
• Inexperience and unfamiliarity with the prerequisite technologies demanded by the objectives of the application.
• Limited communication capability due to COVID-19 pandemic restrictions.

(3) External Interfaces

• HTTP web browser
• Login/Registration page
• Overview of popular stocks
• Input of desired stock watchlist
• Report selected stocks’ status
• GUI must be easy to navigate and understand
• Dismissable pop-ups highlighting features and their uses
• Simple graphs with intuitive filters to provide instant data on:
• Sentiments
• Value
• Current and over time

(3.2) Functions

• Interpret tweet sentiment.
• Track selected tweet sentiments over time.
• Track selected tweet volume over time.

(3.3) Database

• Stock names
• Stock values
• Stock sentiments
• Stock volume
• User Watchlist
• User account information and settings

(3.4) Performance Requirements

• Previously selected stocks reported in under one second.
• Newly selected stocks assessed and reported within one minute.
• Information sentiment analysis is trustworthy and accurate.
• Increases in user base and/or Watchlist size should not significantly interfere with performance.
• Ensure the app is easy to maintain.

(3.5) Software System Attributes

(3.6) Actors and Use Cases

The user interacting with StockEye through their web-browser is the sole actor; however, this actor can either be an unregistered or registered user. The following UML Use Case diagram illustrates how the user will interact with the use cases.

Actors

Actor	Characteristics and Properties
Unregistered User	Users that have not logged-in to StockEye with a user account. Able to interact with basic use cases. Unable to access Watchlist and other user account required use cases.
Registered User	Users that have logged-in to StockEye with a user account. Inherits all use cases accessible to Unregistered Users. Additional use cases accessible.

Use Cases

Use Case	Description
Create Account	Register a user account.
Log-in	Log-in using registered user account.
View Stock List	View the complete list of Stocks available.
Filter Stocks	Filter the Stock List using selected criteria.
Filter by Stock Name	A criteria used to filter the Stock List.
Filter by Sentiment	A criteria used to filter the Stock List.
Filter by Stock Price	A criteria used to filter the Stock List.
View Trending Stock	View the currently trending stocks on Twitter from the Stock List.
View Stock Sentiments	View the sentiment of a selected stock.
View Relevant Tweets	View popular tweets contributing to the sentiment of a selected stock.
Recover Password	Password recovery, in case account password is forgotten.
Change Password	The changing of current account password.
View/Manage Watchlist	View or manage user account Watchlist.
Add to Watchlist	Add a stock to the user account Watchlist.
Remove from Watchlist	Remove a stock from the user account Watchlist.
Set Up Notifications	Set up a notifications either by email or text regarding sentiment fluctuations of selected stocks.