22 KiB

Raw Permalink Blame History

Complete Configuration & Deployment Guide

This document contains the complete configuration guide for the AI Stock Analysis System, intended for users who need advanced features or special deployment methods.

Quick start guide available in README_EN.md. This document covers advanced configuration.

Project Structure

daily_stock_analysis/
├── main.py              # Main entry point
├── src/                 # Core business logic
│   ├── analyzer.py      # AI analyzer
│   ├── config.py        # Configuration management
│   ├── notification.py  # Message push notifications
│   └── ...
├── data_provider/       # Multi-source data adapters
├── bot/                 # Bot interaction module
├── api/                 # FastAPI backend service
├── apps/dsa-web/        # React frontend
├── docker/              # Docker configuration
├── docs/                # Project documentation
└── .github/workflows/   # GitHub Actions

Project Structure
GitHub Actions Configuration
Complete Environment Variables List
Docker Deployment
Local Deployment
Scheduled Task Configuration
Notification Channel Configuration
Data Source Configuration
Advanced Features
Backtesting
Local WebUI Management Interface

GitHub Actions Configuration

1. Fork this Repository

Click the Fork button in the upper right corner.

2. Configure Secrets

Go to your forked repo → Settings → Secrets and variables → Actions → New repository secret

AI Model Configuration (Choose One)

Secret Name	Description	Required
`GEMINI_API_KEY`	Get free key from Google AI Studio	✅*
`OPENAI_API_KEY`	OpenAI-compatible API Key (supports DeepSeek, Qwen, etc.)	Optional
`OPENAI_BASE_URL`	OpenAI-compatible API endpoint (e.g., `https://api.deepseek.com/v1`)	Optional
`OPENAI_MODEL`	Model name (e.g., `deepseek-chat`)	Optional

*Note: Configure at least one of GEMINI_API_KEY or OPENAI_API_KEY

Notification Channels (Multiple can be configured, all will receive notifications)

Secret Name	Description	Required
`WECHAT_WEBHOOK_URL`	WeChat Work Webhook URL	Optional
`FEISHU_WEBHOOK_URL`	Feishu Webhook URL	Optional
`TELEGRAM_BOT_TOKEN`	Telegram Bot Token (get from @BotFather)	Optional
`TELEGRAM_CHAT_ID`	Telegram Chat ID	Optional
`TELEGRAM_MESSAGE_THREAD_ID`	Telegram Topic ID (for sending to topics)	Optional
`DISCORD_WEBHOOK_URL`	Discord Webhook URL (How to create)	Optional
`DISCORD_BOT_TOKEN`	Discord Bot Token (choose one with Webhook)	Optional
`DISCORD_CHANNEL_ID`	Discord Channel ID (required when using Bot)	Optional
`EMAIL_SENDER`	Sender email (e.g., `xxx@qq.com`)	Optional
`EMAIL_PASSWORD`	Email authorization code (not login password)	Optional
`EMAIL_RECEIVERS`	Receiver emails (comma-separated, leave empty to send to self)	Optional
`PUSHPLUS_TOKEN`	PushPlus Token (Get here, Chinese push service)	Optional
`SERVERCHAN3_SENDKEY`	ServerChan v3 Sendkey (Get here, mobile app push service)	Optional
`CUSTOM_WEBHOOK_URLS`	Custom Webhook (supports DingTalk, etc., comma-separated)	Optional
`CUSTOM_WEBHOOK_BEARER_TOKEN`	Bearer Token for custom webhooks (for authenticated webhooks)	Optional

*Note: Configure at least one channel; multiple channels will all receive notifications

Push Behavior Configuration

Secret Name	Description	Required
`SINGLE_STOCK_NOTIFY`	Single stock push mode: set to `true` to push immediately after each stock analysis	Optional
`REPORT_TYPE`	Report type: `simple` (brief) or `full` (complete), Docker environment recommended: `full`	Optional
`ANALYSIS_DELAY`	Delay between stock analysis and market review (seconds) to avoid API rate limits, e.g., `10`	Optional

Other Configuration

Secret Name	Description	Required
`STOCK_LIST`	Watchlist codes, e.g., `600519,300750,002594`	✅
`TAVILY_API_KEYS`	Tavily Search API (for news search)	Recommended
`BOCHA_API_KEYS`	Bocha Search Web Search API (Chinese search optimized, supports AI summaries, multiple keys comma-separated)	Optional
`SERPAPI_API_KEYS`	SerpAPI Backup search	Optional
`TUSHARE_TOKEN`	Tushare Pro Token	Optional

✅ Minimum Configuration Example

To get started quickly, you need at minimum:

AI Model: GEMINI_API_KEY (recommended) or OPENAI_API_KEY
Notification Channel: At least one, e.g., WECHAT_WEBHOOK_URL or EMAIL_SENDER + EMAIL_PASSWORD
Stock List: STOCK_LIST (required)
Search API: TAVILY_API_KEYS (strongly recommended for news search)

Configure these 4 items and you're ready to go!

3. Enable Actions

Go to your forked repository
Click the Actions tab at the top
If prompted, click I understand my workflows, go ahead and enable them

4. Manual Test

Go to Actions tab
Select Daily Stock Analysis workflow on the left
Click Run workflow button on the right
Select run mode
Click green Run workflow to confirm

5. Done!

Default schedule: Every weekday at 18:00 (Beijing Time) automatic execution.

Complete Environment Variables List

AI Model Configuration

Variable	Description	Default	Required
`GEMINI_API_KEY`	Google Gemini API Key	-	✅*
`GEMINI_MODEL`	Primary model name	`gemini-3-flash-preview`	No
`GEMINI_MODEL_FALLBACK`	Fallback model	`gemini-2.5-flash`	No
`OPENAI_API_KEY`	OpenAI-compatible API Key	-	Optional
`OPENAI_BASE_URL`	OpenAI-compatible API endpoint	-	Optional
`OPENAI_MODEL`	OpenAI model name	`gpt-4o`	Optional

*Note: Configure at least one of GEMINI_API_KEY or OPENAI_API_KEY

Notification Channel Configuration

Variable	Description	Required
`WECHAT_WEBHOOK_URL`	WeChat Work Bot Webhook URL	Optional
`FEISHU_WEBHOOK_URL`	Feishu Bot Webhook URL	Optional
`TELEGRAM_BOT_TOKEN`	Telegram Bot Token	Optional
`TELEGRAM_CHAT_ID`	Telegram Chat ID	Optional
`TELEGRAM_MESSAGE_THREAD_ID`	Telegram Topic ID	Optional
`DISCORD_WEBHOOK_URL`	Discord Webhook URL	Optional
`DISCORD_BOT_TOKEN`	Discord Bot Token (choose one with Webhook)	Optional
`DISCORD_CHANNEL_ID`	Discord Channel ID (required when using Bot)	Optional
`EMAIL_SENDER`	Sender email	Optional
`EMAIL_PASSWORD`	Email authorization code (not login password)	Optional
`EMAIL_RECEIVERS`	Receiver emails (comma-separated, leave empty to send to self)	Optional
`CUSTOM_WEBHOOK_URLS`	Custom Webhook (comma-separated)	Optional
`CUSTOM_WEBHOOK_BEARER_TOKEN`	Custom Webhook Bearer Token	Optional
`PUSHOVER_USER_KEY`	Pushover User Key	Optional
`PUSHOVER_API_TOKEN`	Pushover API Token	Optional
`PUSHPLUS_TOKEN`	PushPlus Token (Chinese push service)	Optional
`SERVERCHAN3_SENDKEY`	ServerChan v3 Sendkey	Optional

Feishu Cloud Document Configuration (Optional, solves message truncation issues)

Variable	Description	Required
`FEISHU_APP_ID`	Feishu App ID	Optional
`FEISHU_APP_SECRET`	Feishu App Secret	Optional
`FEISHU_FOLDER_TOKEN`	Feishu Cloud Drive Folder Token	Optional

Feishu Cloud Document setup steps:

Create an app in Feishu Developer Console

Configure GitHub Secrets

Create a group and add the app bot

Add the group as a collaborator to the cloud drive folder (with manage permissions)

Search Service Configuration

Variable	Description	Required
`TAVILY_API_KEYS`	Tavily Search API Key (recommended)	Recommended
`BOCHA_API_KEYS`	Bocha Search API Key (Chinese optimized)	Optional
`SERPAPI_API_KEYS`	SerpAPI Backup search	Optional

Data Source Configuration

Variable	Description	Required
`TUSHARE_TOKEN`	Tushare Pro Token	Optional

Other Configuration

Variable	Description	Default
`STOCK_LIST`	Watchlist codes (comma-separated)	-
`MAX_WORKERS`	Concurrent threads	`3`
`MARKET_REVIEW_ENABLED`	Enable market review	`true`
`SCHEDULE_ENABLED`	Enable scheduled tasks	`false`
`SCHEDULE_TIME`	Scheduled execution time	`18:00`
`LOG_DIR`	Log directory	`./logs`

Docker Deployment

Quick Start

# 1. Clone repository
git clone https://github.com/ZhuLinsen/daily_stock_analysis.git
cd daily_stock_analysis

# 2. Configure environment variables
cp .env.example .env
vim .env  # Fill in API Keys and configuration

# 3. Start container
docker-compose -f ./docker/docker-compose.yml up -d server     # Web service mode (recommended, provides API & WebUI)
docker-compose -f ./docker/docker-compose.yml up -d analyzer   # Scheduled task mode
docker-compose -f ./docker/docker-compose.yml up -d            # Start both modes

# 4. Access WebUI
# http://localhost:8000

# 5. View logs
docker-compose -f ./docker/docker-compose.yml logs -f server

Run Mode Description

Command	Description	Port
`docker-compose -f ./docker/docker-compose.yml up -d server`	Web service mode, provides API & WebUI	8000
`docker-compose -f ./docker/docker-compose.yml up -d analyzer`	Scheduled task mode, daily auto execution	-
`docker-compose -f ./docker/docker-compose.yml up -d`	Start both modes simultaneously	8000

Docker Compose Configuration

docker-compose.yml uses YAML anchors to reuse configuration:

version: '3.8'

x-common: &common
  build: .
  restart: unless-stopped
  env_file:
    - .env
  environment:
    - TZ=Asia/Shanghai
  volumes:
    - ./data:/app/data
    - ./logs:/app/logs
    - ./reports:/app/reports
    - ./.env:/app/.env

services:
  # Scheduled task mode
  analyzer:
    <<: *common
    container_name: stock-analyzer

  # FastAPI mode
  server:
    <<: *common
    container_name: stock-server
    command: ["python", "main.py", "--serve-only", "--host", "0.0.0.0", "--port", "8000"]
    ports:
      - "8000:8000"

Common Commands

# View running status
docker-compose -f ./docker/docker-compose.yml ps

# View logs
docker-compose -f ./docker/docker-compose.yml logs -f server

# Stop services
docker-compose -f ./docker/docker-compose.yml down

# Rebuild image (after code update)
docker-compose -f ./docker/docker-compose.yml build --no-cache
docker-compose -f ./docker/docker-compose.yml up -d server

Manual Image Build

docker build -t stock-analysis .
docker run -d --env-file .env -p 8000:8000 -v ./data:/app/data stock-analysis python main.py --serve-only --host 0.0.0.0 --port 8000

Local Deployment

Install Dependencies

# Python 3.10+ recommended
pip install -r requirements.txt

# Or use conda
conda create -n stock python=3.10
conda activate stock
pip install -r requirements.txt

Command Line Arguments

python main.py                        # Full analysis (stocks + market review)
python main.py --market-review        # Market review only
python main.py --no-market-review     # Stock analysis only
python main.py --stocks 600519,300750 # Specify stocks
python main.py --dry-run              # Fetch data only, no AI analysis
python main.py --no-notify            # Don't send notifications
python main.py --schedule             # Scheduled task mode
python main.py --debug                # Debug mode (verbose logging)
python main.py --workers 5            # Specify concurrency

Scheduled Task Configuration

GitHub Actions Schedule

Edit .github/workflows/daily_analysis.yml:

schedule:
  # UTC time, Beijing time = UTC + 8
  - cron: '0 10 * * 1-5'   # Monday to Friday 18:00 (Beijing Time)

Common time reference:

Beijing Time	UTC cron expression
09:30	`'30 1 * * 1-5'`
12:00	`'0 4 * * 1-5'`
15:00	`'0 7 * * 1-5'`
18:00	`'0 10 * * 1-5'`
21:00	`'0 13 * * 1-5'`

Local Scheduled Tasks

# Start scheduled mode (default 18:00 execution)
python main.py --schedule

# Or use crontab
crontab -e
# Add: 0 18 * * 1-5 cd /path/to/project && python main.py

Notification Channel Configuration

WeChat Work

Add "Group Bot" in WeChat Work group chat
Copy Webhook URL
Set WECHAT_WEBHOOK_URL

Feishu

Add "Custom Bot" in Feishu group chat
Copy Webhook URL
Set FEISHU_WEBHOOK_URL

Talk to @BotFather to create a Bot
Get Bot Token
Get Chat ID (via @userinfobot)
Set TELEGRAM_BOT_TOKEN and TELEGRAM_CHAT_ID
(Optional) To send to Topic, set TELEGRAM_MESSAGE_THREAD_ID (get from Topic link)

Email

Enable SMTP service for your email
Get authorization code (not login password)
Set EMAIL_SENDER, EMAIL_PASSWORD, EMAIL_RECEIVERS

Supported email providers:

QQ Mail: smtp.qq.com:465
163 Mail: smtp.163.com:465
Gmail: smtp.gmail.com:587

Custom Webhook

Supports any POST JSON Webhook, including:

DingTalk Bot
Discord Webhook
Slack Webhook
Bark (iOS push)
Self-hosted services

Set CUSTOM_WEBHOOK_URLS, separate multiple with commas.

Discord

Discord supports two push methods:

Method 1: Webhook (Recommended, Simple)

Create Webhook in Discord channel settings
Copy Webhook URL
Configure environment variable:

DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/xxx/yyy

Method 2: Bot API (Requires more permissions)

Create application in Discord Developer Portal
Create Bot and get Token
Invite Bot to server
Get Channel ID (right-click channel in developer mode)
Configure environment variables:

DISCORD_BOT_TOKEN=your_bot_token
DISCORD_CHANNEL_ID=your_channel_id

Pushover (iOS/Android Push)

Pushover is a cross-platform push service supporting iOS and Android.

Register Pushover account and download App
Get User Key from Pushover Dashboard
Create Application to get API Token
Configure environment variables:

PUSHOVER_USER_KEY=your_user_key
PUSHOVER_API_TOKEN=your_api_token

Features:

Supports iOS/Android
Supports notification priority and sound settings
Free quota sufficient for personal use (10,000 messages/month)
Messages retained for 7 days

Data Source Configuration

System defaults to AkShare (free), also supports other data sources:

AkShare (Default)

Free, no configuration needed
Data source: Eastmoney scraper

Tushare Pro

Requires registration to get Token
More stable, more comprehensive data
Set TUSHARE_TOKEN

Baostock

Free, no configuration needed
Used as backup data source

YFinance

Free, no configuration needed
Supports US/HK stock data

Advanced Features

Hong Kong Stock Support

Use hk prefix for HK stock codes:

STOCK_LIST=600519,hk00700,hk01810

Multi-Model Switching

Configure multiple models, system auto-switches:

# Gemini (primary)
GEMINI_API_KEY=xxx
GEMINI_MODEL=gemini-3-flash-preview

# OpenAI compatible (backup)
OPENAI_API_KEY=xxx
OPENAI_BASE_URL=https://api.deepseek.com/v1
OPENAI_MODEL=deepseek-chat

Debug Mode

python main.py --debug

Log file locations:

Regular logs: logs/stock_analysis_YYYYMMDD.log
Debug logs: logs/stock_analysis_debug_YYYYMMDD.log

Backtesting

The backtesting module automatically validates historical AI analysis records against actual price movements, evaluating the accuracy of analysis recommendations.

How It Works

Selects AnalysisHistory records past the cooldown period (default 14 days)
Fetches daily bar data after the analysis date (forward bars)
Infers expected direction from the operation advice and compares against actual movement
Evaluates stop-loss/take-profit hit conditions and simulates execution returns
Aggregates into overall and per-stock performance metrics

Operation Advice Mapping

Operation Advice	Position	Expected Direction	Win Condition
Buy / Add / Strong Buy	long	up	Return >= neutral band
Sell / Reduce / Strong Sell	cash	down	Decline >= neutral band
Hold	long	not_down	No significant decline
Wait / Observe	cash	flat	Price within neutral band

Configuration

Set the following variables in .env (all optional, have defaults):

Variable	Default	Description
`BACKTEST_ENABLED`	`true`	Whether to auto-run backtest after daily analysis
`BACKTEST_EVAL_WINDOW_DAYS`	`10`	Evaluation window (trading days)
`BACKTEST_MIN_AGE_DAYS`	`14`	Only backtest records older than N days to avoid incomplete data
`BACKTEST_ENGINE_VERSION`	`v1`	Engine version, used to distinguish results when logic is updated
`BACKTEST_NEUTRAL_BAND_PCT`	`2.0`	Neutral band threshold (%), ±2% treated as range-bound

Auto-run

Backtesting triggers automatically after the daily analysis flow completes (non-blocking; failures do not affect notifications). It can also be triggered manually via API.

Evaluation Metrics

Metric	Description
`direction_accuracy_pct`	Direction prediction accuracy (expected direction matches actual)
`win_rate_pct`	Win rate (wins / (wins + losses), excludes neutral)
`avg_stock_return_pct`	Average stock return percentage
`avg_simulated_return_pct`	Average simulated execution return (including SL/TP exits)
`stop_loss_trigger_rate`	Stop-loss trigger rate (only counts records with SL configured)
`take_profit_trigger_rate`	Take-profit trigger rate (only counts records with TP configured)

FastAPI API Service

FastAPI provides RESTful API service for configuration management and triggering analysis.

Startup Methods

Command	Description
`python main.py --serve`	Start API service + run full analysis once
`python main.py --serve-only`	Start API service only, manually trigger analysis

Features

Configuration Management - View/modify watchlist
Quick Analysis - Trigger analysis via API
Real-time Progress - Analysis task status updates in real-time, supports parallel tasks
Backtest Validation - Evaluate historical analysis accuracy, query direction win rate and simulated returns
API Documentation - Visit /docs for Swagger UI

API Endpoints

Endpoint	Method	Description
`/api/v1/analysis/analyze`	POST	Trigger stock analysis
`/api/v1/analysis/tasks`	GET	Query task list
`/api/v1/analysis/status/{task_id}`	GET	Query task status
`/api/v1/history`	GET	Query analysis history
`/api/v1/backtest/run`	POST	Trigger backtest
`/api/v1/backtest/results`	GET	Query backtest results (paginated)
`/api/v1/backtest/performance`	GET	Get overall backtest performance
`/api/v1/backtest/performance/{code}`	GET	Get per-stock backtest performance
`/api/health`	GET	Health check
`/docs`	GET	API Swagger documentation

Usage examples:

# Health check
curl http://127.0.0.1:8000/api/health

# Trigger analysis (A-shares)
curl -X POST http://127.0.0.1:8000/api/v1/analysis/analyze \
  -H 'Content-Type: application/json' \
  -d '{"stock_code": "600519"}'

# Query task status
curl http://127.0.0.1:8000/api/v1/analysis/status/<task_id>

# Trigger backtest (all stocks)
curl -X POST http://127.0.0.1:8000/api/v1/backtest/run \
  -H 'Content-Type: application/json' \
  -d '{"force": false}'

# Trigger backtest (specific stock)
curl -X POST http://127.0.0.1:8000/api/v1/backtest/run \
  -H 'Content-Type: application/json' \
  -d '{"code": "600519", "force": false}'

# Query overall backtest performance
curl http://127.0.0.1:8000/api/v1/backtest/performance

# Query per-stock backtest performance
curl http://127.0.0.1:8000/api/v1/backtest/performance/600519

# Paginated backtest results
curl "http://127.0.0.1:8000/api/v1/backtest/results?page=1&limit=20"

Custom Configuration

Modify default port or allow LAN access:

python main.py --serve-only --host 0.0.0.0 --port 8888

Supported Stock Code Formats

Type	Format	Examples
A-shares	6-digit number	`600519`, `000001`, `300750`
HK stocks	hk + 5-digit number	`hk00700`, `hk09988`

Notes

Browser access: http://127.0.0.1:8000 (or your configured port)
After analysis completion, notifications are automatically pushed to configured channels
This feature is automatically disabled in GitHub Actions environment

FAQ

Q: Push messages getting truncated?

A: WeChat Work/Feishu have message length limits, system already auto-segments messages. For complete content, configure Feishu Cloud Document feature.

Q: Data fetch failed?

A: AkShare uses scraping mechanism, may be temporarily rate-limited. System has retry mechanism configured, usually just wait a few minutes and retry.

Q: How to add watchlist stocks?

A: Modify STOCK_LIST environment variable, separate multiple codes with commas.

Q: GitHub Actions not executing?

A: Check if Actions is enabled, and if cron expression is correct (note it's UTC time).

For more questions, please submit an Issue

22 KiB Raw Permalink Blame History

Complete Configuration & Deployment Guide

Project Structure

Table of Contents

GitHub Actions Configuration

1. Fork this Repository

2. Configure Secrets

AI Model Configuration (Choose One)

Notification Channels (Multiple can be configured, all will receive notifications)

Push Behavior Configuration

Other Configuration

✅ Minimum Configuration Example

3. Enable Actions

4. Manual Test

5. Done!

Complete Environment Variables List

AI Model Configuration

Notification Channel Configuration

Feishu Cloud Document Configuration (Optional, solves message truncation issues)

Search Service Configuration

Data Source Configuration

Other Configuration

Docker Deployment

Quick Start

Run Mode Description

Docker Compose Configuration

Common Commands

Manual Image Build

Local Deployment

Install Dependencies

Command Line Arguments

Scheduled Task Configuration

GitHub Actions Schedule

Local Scheduled Tasks

Notification Channel Configuration

WeChat Work

Feishu

Telegram

Email

Custom Webhook

Discord

Pushover (iOS/Android Push)

Data Source Configuration

AkShare (Default)

Tushare Pro

Baostock

YFinance

Advanced Features

Hong Kong Stock Support

Multi-Model Switching

Debug Mode

Backtesting

How It Works

Operation Advice Mapping

Configuration

Auto-run

Evaluation Metrics

FastAPI API Service

Startup Methods

Features

API Endpoints

Custom Configuration

Supported Stock Code Formats

Notes

FAQ

Q: Push messages getting truncated?

Q: Data fetch failed?

Q: How to add watchlist stocks?

Q: GitHub Actions not executing?

22 KiB

Raw Permalink Blame History