How wenjuinchuah/stock_view_backend works
Project Type and Purpose
• This repository implements a standalone backend microservice (REST API) for the “Stock View” system.
• It is built with FastAPI (uvicorn ASGI server), SQLAlchemy (models/crud), and orchestrated via Docker Compose. Its core responsibility is to expose endpoints for stock data (price lists, stock details, screeners), persist information in a database, and fetch or scrape external stock data.
File Structure Analysis
Top-level artifacts:
• Dockerfile / docker-compose.yml / start.sh – containerization and orchestration
• requirements.txt – Python dependencies
• app/ – application code
├─ api/
├─ endpoints/ – FastAPI route handlers (price_list.py, stock.py, stock_screener.py)
├─ crud/ – database access & business logic (price_list.py, stock_scrapper.py, etc.)
├─ models/ – SQLAlchemy ORM definitions (Stock, PriceList, Screener models)
└─ dependencies/ – shared DI providers (database session)
├─ assets/ – static data (stock_list.csv)
└─ main.py – FastAPI app instantiation and router mounting
README Insights
• Confirms use of Python 3.8+, uvicorn, virtualenv, Docker Compose.
• No external services except the database (likely Postgres/MySQL) and possibly public stock-data sources invoked by scrapers.
a. Main Components
• Client(s) – e.g., Web frontend, Postman
• FastAPI App – ASGI server (uvicorn)
– Router Layer: app/main.py registers endpoints
– Endpoints (app/api/endpoints/*.py)
– CRUD Layer (app/api/crud/*.py)
– Models (app/api/models/*.py)
– Dependencies (DB session factory)
• Database – SQL database container (PostgreSQL or MySQL)
• External Data Sources – HTTP stock APIs or scraping targets
• Static Asset – stock_list.csv loader
b. Interactions
1. Client → HTTP(S) → Uvicorn/ASGI
2. Router dispatches to endpoint function
3. Endpoint invokes CRUD services (business logic)
4. CRUD layer reads/writes via SQLAlchemy ORM to Database
5. For real-time data: CRUD calls scrapers / external HTTP APIs
6. Responses flow back up to client
c. Architectural Patterns
• Layered Architecture (Presentation → Controller/Router → Service/CRUD → Data)
• Dependency Injection via FastAPI’s Depends (database sessions, configs)
• Containerization (Docker image + Compose network)
d. Key Technologies
• Python 3.8+, FastAPI, Uvicorn
• SQLAlchemy ORM
• Docker & Docker Compose
• External HTTP libraries (e.g., requests or httpx for scrapers)
Detail Checklist
• Three endpoint groups (price_list, stock, stock_screener) under the Router.
• Dependency Injector for DB sessions.
• Static CSV asset loader.
• Docker Compose context: network and volume mappings.
• Call out any background tasks or cron-style scrapers if applicable.