Added test files

Author: dimtics

.dockerignore

@@ -0,0 +1,108 @@
+# Include any files or directories that you don't want to be copied to your
+# container here (e.g., local build artifacts, temporary files, etc.).
+#
+# For more help, visit the .dockerignore file reference guide at
+# https://docs.docker.com/go/build-context-dockerignore/
+
+**/.DS_Store
+**/__pycache__
+**/.venv
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/bin
+**/charts
+**/docker-compose*
+**/compose.y*ml
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+LICENSE
+README.md
+.git
+.gitignore
+.venv/
+__pycache__/
+*.log
+.python-version
+data/
+
+
+# Python-generated files
+__pycache__/
+.mypy_cache
+.ruff_cache
+*.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
+
+# Scratch Pad
+scratch.py

.github/workflows/ci_cd.yml

@@ -1,38 +1,32 @@
-name: CI/CD
+name: CI/CD Pipeline
 
 on:
   push:
-    branches: [ main ]
+    branches: [dev, main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
-  test:
+  ci:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.11'
-    - name: Install dependencies
-      run: |
-        pip install uv
-        uv pip install -e .[dev]
-    - name: Run tests
-      run: pytest
+      - uses: actions/checkout@v4
+      - name: Build dev image
+        run: make docker-build
+      - name: Run linting
+        run: make docker-check
+      - name: Run tests
+        run: make docker-test
 
-  deploy:
-    needs: test
-    runs-on: ubuntu-latest
+  cd:
+    needs: ci
     if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Build and push Docker image
-      env:
-        DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
-        DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
-      run: |
-        docker build -t your-docker-repo/stock-valuation-app:latest .
-        echo $DOCKER_PASSWORD | docker login -u $DOCKER_USERNAME --password-stdin
-        docker push your-docker-repo/stock-valuation-app:latest
+      - uses: actions/checkout@v4
+      - name: Build prod image
+        run: make docker-build-prod
+      - name: Login to Docker Hub
+        run: docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}
+      - name: Push prod image
+        run: make docker-push

.streamlit/config.toml

@@ -1,6 +1,6 @@
 [theme]
 base="dark"
-backgroundColor="#F5F5F5"    #  "#E3F2FD"
+backgroundColor="#F5F5F5"
 secondaryBackgroundColor="#F0F2F6"
 textColor="#333333"
 font="sans serif"

Dockerfile

@@ -0,0 +1,54 @@
+# Build stage (with dev tools for linting, testing, etc.)
+FROM python:3.11-slim AS builder
+WORKDIR /app
+
+# Prevent Python from writing pyc files and buffering output
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1
+
+# Install uv
+RUN pip install --no-cache-dir uv
+
+# Copy dependency files first for caching
+COPY pyproject.toml uv.lock /app/
+
+# Sync dependencies (includes streamlit, ruff, pytest if in pyproject.toml)
+RUN uv sync --frozen
+
+# Copy the rest of the project
+COPY . /app
+
+# Final stage (production, lean image)
+FROM python:3.11-slim AS production
+WORKDIR /app
+
+# Prevent Python from writing pyc files and buffering output
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1
+
+# Create a non-privileged user
+ARG UID=10001
+RUN adduser \
+    --disabled-password \
+    --gecos "" \
+    --home "/nonexistent" \
+    --shell "/sbin/nologin" \
+    --no-create-home \
+    --uid "${UID}" \
+    appuser
+
+# Copy the virtual env and project files
+COPY --from=builder /app/.venv /app/.venv
+COPY . /app
+
+# Set PATH to use the virtual env
+ENV PATH="/app/.venv/bin:$PATH"
+
+# Switch to non-privileged user
+USER appuser
+
+# Expose Streamlit's default port
+EXPOSE 8501
+
+# Run Streamlit app
+CMD ["streamlit", "run", "app.py"]

Makefile

@@ -0,0 +1,56 @@
+.PHONY: all deps check test docker-build docker-check docker-test docker-build-prod docker-run docker-tag docker-push docker-clean
+
+# Dependency management
+deps:
+	uv sync
+
+# Linting and formatting
+check:
+	- uv run ruff check . --fix
+	- uv run ruff format .
+
+# Testing
+test:
+	uv run pytest -v
+
+# Dev: Build the dev image (builder stage)
+docker-build:
+	docker build --target builder -t stock-analysis-project:dev .
+
+# Dev: ruff check
+docker-check: docker-build
+	docker run --rm -v $(PWD):/app stock-analysis-project:dev ruff check .
+
+# Dev: test
+docker-test: docker-build
+	docker run --rm stock-analysis-project:dev pytest --verbose
+
+# Prod: Build the production image (production stage)
+docker-build-prod:
+	docker build --target production -t stock-analysis-project:latest .
+
+# Prod: Run the Streamlit app (production image)
+docker-run: docker-build-prod
+	docker run --rm -e API_KEY=${API_KEY} -v $(PWD)/data:/app/data -p 8501:8501 stock-analysis-project:latest
+
+# Prod: Tag production image
+docker-tag: docker-build-prod
+	docker tag stock-analysis-project skytics/stock-analysis-project:latest
+
+# Prod: Push prod image to Docker Hub
+docker-push: docker-tag
+	docker push skytics/stock-analysis-project:latest
+
+# Delete images
+docker-clean:
+	- docker image rm stock-analysis-project:dev || true
+	- docker image rm stock-analysis-project:latest || true
+
+# All-in-one
+all: check test docker-build
+	@echo "All checks passed!"
+
+
+
+
+

pyproject.toml

@@ -10,7 +10,6 @@ requires-python = ">=3.12"
 
 dependencies = [
     "asyncio>=3.4.3",
-    "duckdb>=1.1.3",
     "httpx>=0.27.2",
     "plotly>=5.24.1",
     "polars>=1.12.0",
@@ -20,8 +19,13 @@ dependencies = [
 
 [dependency-groups]
 dev = [
-    "ipykernel>=6.29.5",
-    "mypy>=1.13.0",
     "pytest>=8.3.3",
     "ruff>=0.7.3",
-]
+]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]

src/app.py

@@ -592,10 +592,10 @@ def main():
         unsafe_allow_html=True,
     )
 
-    st.title("Stock Valuation Dashboard")
+    st.title("Stock Data View")
     # st.divider()
     st.subheader(
-        "Get stock quality and valuation insights from historical financial data.",
+        "Visualize stock fundamentals, ratings, and historical data using the Financial Modeling Prep (FMP) API",
         divider="gray",
     )
 

tests/test_data_validation.py

@@ -0,0 +1,13 @@
+from src.data_validation import get_validated_stock_data
+
+
+def test_get_validated_stock_data_valid_ticker():
+    """Test data validation with valid ticker"""
+    ticker = "AAPL"
+    data = get_validated_stock_data(ticker)
+
+    assert data is not None
+    assert "profile" in data
+    assert "quote" in data
+    assert "ratings" in data
+    assert "key_metrics_ttm" in data