Investment Report Generator | Upsonic

Investment Report Generator example for Upsonic framework.

Introduction

This advanced example shows how to build a sophisticated investment analysis system that combines market research, financial analysis, and portfolio management. The workflow uses a three-stage approach:

• Comprehensive stock analysis and market research
• Investment potential evaluation and ranking
• Strategic portfolio allocation recommendations

Key capabilities:

• Real-time market data analysis
• Professional financial research
• Investment risk assessment
• Portfolio allocation strategy
• Detailed investment rationale

Example companies to analyze:

• “AAPL, MSFT, GOOGL” (Tech Giants)
• “NVDA, AMD, INTC” (Semiconductor Leaders)
• “TSLA, F, GM” (Automotive Innovation)
• “JPM, BAC, GS” (Banking Sector)
• “AMZN, WMT, TGT” (Retail Competition)
• “PFE, JNJ, MRNA” (Healthcare Focus)
• “XOM, CVX, BP” (Energy Sector)

Installation

Prerequisites

• Python 3.12 or higher
• uv package manager
• Make (optional, for using Makefile commands)

Clone the Repository

Using HTTPS:

git clone https://github.com/mertssmnoglu/upsonic-investment-report-generator.git
cd upsonic-investment-report-generator

Using SSH:

git clone git@github.com:mertssmnoglu/upsonic-investment-report-generator.git
cd upsonic-investment-report-generator

---

Setup

Prepare the environment

uv venv --python 3.12

Activate the virtual environment.

source .venv/bin/activate

Install the dependencies

# Sync the dependencies according to the uv.lock file
uv sync

Environment Variables

# Required
OPENAI_API_KEY=your_openai_api_key

# Optional, default is false
DEMO=true/false

You can copy .env.example as .env and fill in the required values.

cp .env.example .env

Jupyter Notebook

This project includes a Jupyter Notebook for interactive exploration and analysis of investment data. You can find the notebook in the notebooks directory.

Demo App

Demo app introduces a command line investment report generator that generates detailed investment reports based on the provided company symbols(tickers).

Run the demo and see it in action:

make demo

Server

There is a server that can be used to run the investment report generator as a web service.

It saves the generated reports in the reports directory.

make run

uvicorn main:app --host 0.0.0.0 --port 8000 --app-dir src

Docker

You can run the investment report generator server as a Docker container.

Pull from Docker Hub

docker pull mertssmnoglu/upsonic-investment-report-generator

docker run -p 8000:8000 --detach --env-file .env mertssmnoglu/upsonic-investment-report-generator

Manual Build and Run

docker build -t upsonic-investment-report-generator .

docker run -p 8000:8000 --detach --env-file .env upsonic-investment-report-generator:latest

Please see DEPLOYMENT.md for more details on deploying the investment report generator server.

License

This project is licensed under the MIT License.