� Important Clarification - DashScope API Key Requirements:
� Updated Documentation:
- docs/en-US/quick_start_guide.md
- docs/en-US/configuration_guide.md
- .env.example
� DashScope API Key is ONLY required when:
1. � Analyzing Chinese A-share stocks (uses TongDaXin data + DashScope embeddings)
2. � Choosing DashScope as LLM provider (Qwen models)
✅ For US Stock Analysis:
- OpenAI + FinnHub: ✅ No DashScope needed
- Google AI + FinnHub: ✅ No DashScope needed
- Anthropic + FinnHub: ✅ No DashScope needed
✅ DashScope Required Cases:
- China A-Share + Any LLM: ✅ DashScope needed (for embeddings)
- US Stock + DashScope LLM: ✅ DashScope needed (for Qwen models)
- China A-Share + DashScope LLM: ✅ DashScope needed (both reasons)
� Updated Configuration Examples:
- Example 1: US stocks with OpenAI (no DashScope)
- Example 2: US stocks with Google AI (no DashScope)
- Example 3: China A-shares (DashScope required)
- Example 4: US stocks with DashScope LLM (DashScope required)
- Example 5: Full features with database
� Key Benefits:
- Users can start with familiar LLM providers (OpenAI/Google)
- DashScope only needed for Chinese market features
- Clear separation of requirements by use case
- Reduced barrier to entry for US-only users
This clarification makes it easier for users to understand
exactly when they need which API keys based on their
specific use case and market focus.
� Environment Configuration Localization:
- Translate all Chinese comments to English
- Maintain same configuration structure and values
- Update project references from TradingAgents-CN to TradingAgents
- Add enhanced usage instructions and quick start guide
� Key Changes:
- Header: TradingAgents Environment Variables Configuration Example
- API Keys: Clear English descriptions for all providers
- Database: English explanations for MongoDB and Redis configuration
- Reddit API: English comments for social media integration
- Usage Instructions: Comprehensive English setup guide
� Enhanced Documentation:
- Added Quick Start Guide section
- Separate instructions for minimal vs full feature setup
- Clear step-by-step configuration process
- Docker commands for database setup
- Dependency installation instructions
Now .env.example provides clear English guidance for:
- International users and developers
- API key configuration and sources
- Database setup (optional)
- Quick start vs full feature deployment
- Testing and validation steps
This makes the project more accessible to global users
while maintaining all functionality and configuration options.
- Add .env.example with comprehensive configuration template
- Add .env with sanitized default values (no real API keys)
- Based on Chinese version configuration with English comments
- Includes all necessary API configurations:
* DashScope (Chinese LLM)
* Finnhub (Financial data)
* OpenAI, Google AI, Anthropic (Optional LLMs)
* Reddit API (Social sentiment)
* MongoDB and Redis (Database/Cache)
Configuration features:
- Clear instructions for each API key
- Database enable/disable switches
- Comprehensive comments and usage guide
- Security warnings about sensitive data
Usage:
1. Copy .env.example to .env
2. Fill in actual API keys
3. Configure at minimum: DASHSCOPE_API_KEY and FINNHUB_API_KEY
4. Run: python main.py
- Added support for running CLI and Ollama server via Docker
- Introduced tests for local embeddings model and standalone Docker setup
- Enabled conditional Ollama server launch via LLM_PROVIDER
liuping
Yijia Xiao
Geeta Chauhan