README.md

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Acknowledgements

About The Project

This is a lightweight streamlit app for understanding financial terms, fundamental ratios, and performance metrics. It uses fmpcloud to pull periodic data of stock prices, annual statements, balance sheets of listed companies in the US. The explanation of the terms used in the app is taken from Investopedia.

Select a symbol name of the company you want to assess. If the symbol does not match any name, then the selectbox will display search results matching the symbol. Select the company and press start. The app will display fundamental terms and display performance from historical financial statements.

Built With

Streamlit

Prerequisites

Python3

Installation

1. Get a free API Key at https://fmpcloud.com
2. Install dependencies

pip install -r requirements.txt

3. Run

streamlit run fundamentals_app.py

Usage

Coming soon

Roadmap

Coming soon

Contributing

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.

Acknowledgements

• Python Wrapper for fmpcloud API