Initial commit

Author: dimtics

.dockerignore

@@ -0,0 +1,61 @@
+# Git
+.git
+.gitignore
+
+# Python
+__pycache__
+*.pyc
+*.pyo
+*.pyd
+.Python
+env
+venv
+pip-log.txt
+pip-delete-this-directory.txt
+.tox
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.log
+.mypy_cache
+.pytest_cache
+.hypothesis
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+
+# IDEs
+.vscode
+.idea
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Project specific
+tests/
+*.md
+LICENSE
+.github/
+docker-compose.yml
+
+# DuckDB
+*.duckdb
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# uv specific
+.uv/

.github/workflows/ci_cd.yml

@@ -0,0 +1,60 @@
+# Python-generated files
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Environment variables
+.env
+.venv
+venv/
+env/
+ENV/
+
+# IDEs and editors
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Operating System Files
+.DS_Store
+Thumbs.db
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pytest
+.pytest_cache/
+
+# Coverage reports
+htmlcov/
+.coverage
+.coverage.*
+.cache
+
+# Logs
+*.log
+
+# uv specific
+.uv/
+
+# DuckDB
+*.duckdb

.gitignore

@@ -0,0 +1 @@
+3.12

.python-version

@@ -0,0 +1,92 @@
+# Stock Valuation Dashboard
+
+## Overview
+
+This project is a web-based stock valuation dashboard that helps investors analyze dividend growth stocks. It provides insights into stock quality and valuation based on historical financial data.
+
+Key features:
+- Fetches financial data from Financial Modeling Prep API
+- Calculates growth rates for revenue, dividends, cash flow, and other metrics
+- Determines if a stock is a quality dividend growth stock
+- Assesses whether a stock is undervalued or reasonably valued
+- Visualizes key metrics and growth rates
+
+## Tech Stack
+
+- Python 3.11+
+- FastAPI: Web framework for building APIs
+- Dash: React-based framework for building analytical web applications
+- Polars: Fast DataFrame library for data manipulation
+- Pydantic: Data validation using Python type annotations
+- PyArrow: Efficient data interchange format
+- DuckDB: Embedded analytical database
+- uv: Python packaging and dependency management tool
+- Docker: Containerization
+- GitHub Actions: CI/CD pipeline
+
+## Project Structure
+
+stock_valuation_app/
+├── .github/workflows/ # CI/CD configuration
+├── src/
+│ └── stock_valuation_app/
+│ ├── api/ # FastAPI routes
+│ ├── data/ # Data fetching and processing
+│ ├── models/ # Pydantic models
+│ ├── services/ # Business logic
+│ └── ui/ # Dash dashboard
+├── tests/ # Unit and integration tests
+├── Dockerfile
+├── docker-compose.yml
+├── pyproject.toml # Project metadata and dependencies
+├── README.md
+└── uv.lock # Dependency lock file
+
+
+
+## Setup and Installation
+
+1. Clone the repository:
+git clone https://github.com/dimtics/stock_valuation_app.git
+cd stock_valuation_app
+
+2. Install uv and project dependencies:
+pip install uv
+uv pip install -e .
+
+3. Set up environment variables:
+Create a `.env` file in the project root and add your Financial Modeling Prep API key:
+FMP_API_KEY=your_api_key_here
+
+4. Run the application:
+uvicorn stock_valuation_app:app --reload
+
+5. Open your browser and navigate to `http://localhost:8000/dashboard` to view the dashboard.
+
+
+## Docker Deployment
+
+To run the application using Docker:
+
+1. Build the Docker image:
+docker build -t stock-valuation-app .
+docker run -p 8000:8000 -e FMP_API_KEY=your_api_key_here stock-valuation-app
+
+Alternatively, use Docker Compose:
+docker-compose up
+
+
+
+## Usage
+
+1. Enter a stock symbol in the input field on the dashboard.
+2. Click the "Analyze" button to fetch and analyze the stock data.
+3. View the growth rates, quality assessment, and valuation results.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

Dockerfile

@@ -0,0 +1,19 @@
+api:
+  base_url: "https://financialmodelingprep.com/api/v3"
+
+valuation:
+  default_pe_ratio: 15
+  quality_threshold:
+    revenue_growth: 0.05
+    dividend_growth: 0.05
+
+dashboard:
+  refresh_interval: 300  # in seconds
+
+database:
+  type: "duckdb"
+  file: "stock_data.duckdb"
+
+logging:
+  level: "INFO"
+  file: "app.log"

README.md

@@ -0,0 +1,33 @@
+[project]
+name = "stock-valuation-app"
+version = "0.1.0"
+description = "A single-page web app displaying stock data, growth charts, and valuation insights."
+readme = "README.md"
+authors = [
+    { name = "Dimeji Salau", email = "dimejisalau@protonmail.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "dash>=2.18.2",
+    "duckdb>=1.1.3",
+    "fastapi>=0.115.4",
+    "httpx>=0.27.2",
+    "polars>=1.12.0",
+    "pyarrow>=18.0.0",
+    "pydantic>=2.9.2",
+]
+
+[project.scripts]
+stock-valuation-app = "stock_valuation_app:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "ipykernel>=6.29.5",
+    "mypy>=1.13.0",
+    "pytest>=8.3.3",
+    "ruff>=0.7.3",
+]

config.yml

@@ -0,0 +1,2 @@
+def main() -> None:
+    print("Hello from stock-valuation-app!")