finn

Disclaimer

About The Project

A one-of-a-kind FINNancial analytics Discord bot!

Finn is a bot that seeks to provide a multitude of features to improve financial literacy and smoothen the learning curve that beginners may face coming into finance. By accessing Yahoo Finance’s python library, Finn can provide a wide range of key statistics that new or experienced investors may need when assessing whether to invest in a company. Finn can also help you plan and build a portfolio based on what you need! If you input a list of stock tickers, Finn will algorithmically produce a weighted portfolio of a specified type for your use.

Built With

• discord.py
• discord.py-slash-commands
• DataStax Astra's Apache Cassandra Databases
• Domain.com
• Linode Cloud
• yFinance

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

Prerequisites

• Python 3.8.x, pip3

1. Update before installing new packages

   sudo apt-get update
   

2. Check Python version

   python3 --version
   

3. If Python version < 3.8

   sudo apt install python3.8
   

4. Validate

   python3.8 --version
   

5. Install pip3

   sudo apt-get -y install python3-pip
   

6. Validate

   pip3 --version
   

Installation

1. Clone the repo

   git clone https://github.com/Finn-Discord-Bot/finn.git
   

2. cd into repo directory

   cd finn
   

3. Install Prerequisite Libraries

   pip3 install -r requirements.txt
   

4. Create a Discord Bot on the Discord Developer Portal
5. Configure DataStaxAstra Cassandra Database
   • Initialize CQL Database with keyspace portfolios
   • Click on Connect in the initialized database. Download and add secure-connect-database-name.zip to main directory.
6. Add tokens to config.json
   • Copy tokens from DataStax Astra Database into config.json
   • Bot tokens for Discord can be found in the Discord Developer Portal.
7. Start bot

   python3 main.py
   

Usage

/help Provides a list of all possible commands

There are three groups of commands

Stock Commands

• /companyinfo takes in a single ticker and displays the Company Location, Company Industry, and Market Capitalization of the specified ticker.
• /stockinfo takes in a single ticker and displays various financial statistics about the specified ticker
• /stockhistory takes in a single ticker, a start date, and an end date. It displays the tickers historical values over the specified date range.

Finance Commands

• /lasttradingday displays the last date where trading has occured.
• /options takes in a single ticker, a range, and the option type (call or put). The range indicates how close the user will like the options to be to the current stock price. The option type indicates if the user wants to see calls or puts.

Portfolio Commands

• /createportfolio takes in a portfolio type, a list of tickers, and the starting capital. There are various types of portfolios. Equally Weighted produces a portfolio of equal weight amongst the tickers. Price Weighted weighs the tickers by the share price. Market-Capitalization Weighted weighs the tickers based off of the market capitalization of each ticker. Risky Smart Weighted weighs the tickers by considering the underlying risk of the ticker, compared to the greatest possible return. This portfolio is expected to have the greatest value movements, which may be in either direction. Safe Smart Weighted weighs the tickers by considering the overall risk of each ticker. It gives precedence to the tickers whos risk is lowest. This portfoli is expected to have the least value movements. The starting capital is the amount of cash the user wants to create the portfolio with. Every user can create their own portfolio, and will be stored seperately
• /displayportfolio displays the current users portfolio.
• /addstock takes in a ticker and the quantity of shares. It adds the specified shares to the users portfolio.
• /removestock takes in a ticker and removes it from the users portfolio.
• /cleartable clears the users current portfolio.

For more examples, please refer to the Demo

Roadmap

• Web interface to access your portfolio and other features.
• Allow multiple portfolios.
• Enable the ability to purchase the same stock twice in a portfolio.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Timothy Zheng - Linkedin - timothyzheng123@gmail.com

Ethan Misa - Linkedin - ethan.misa@gmail.com

Karen Huang - Linkedin - karen.kl.huang@gmail.com

Daniel Jiang - Linkedin - danieljiang378@gmail.com

Vanessa Liu - Linkedin - vanessaliu014@gmail.com

Daniel Kim - Linkedin - danielkim1345@gmail.com

Yuqian Lin - Linkedin - yuqianlintsks502@gmail.com

Victoria Zhao - Linkedin - victoria17zhao@gmail.com

Jacky Xu - Linkedin - jacky.x0423@gmail.com

Devpost Link: https://devpost.com/software/finn-u7hden