How mattappsaibagus-wq/halal-global-stocks-and-crypto works
This repository is a Shariah-screened global equities and spot-crypto scanner with a dashboard and research tools. Its main workflow screens each watchlist symbol first, analyzes only HALAL assets for signals, consolidates recommendations, and publishes scan results for the dashboard. News is displayed as context, not used as a trading signal. README capabilities also include compliance alerts, signal tracking, backtesting, momentum rotation, and basket planning. The pipeline and selected agent interactions are supported by sampled source; some dashboard and scheduling details are documented in the README but their implementation was not sampled.
Main entry points: run_pipeline.py Scan Pipeline · shariah_agent.py Shariah Screener · advisor.py Recommendation Advisor · learning_loop.py Signal Learning Loop
Components 23
Screening and Signals
- Scan Pipeline
run_pipeline.py - Shariah Screener
agents/shariah_agent.py - Screening Standards
agents/standards.py - Crypto Allowlist
data/halal_crypto_registry.json - Technical Agents
agents - News Scanner
agents/news_scanner.py
Advice and Tracking
- Recommendation Advisor
agents/advisor.py - Advisor Configuration
data/advisor_config.json - Signal Learning Loop
agents/learning_loop.py - Learning History
data - Trade Executor
trading/executor.py - Execution Risk Guards
trading/risk_guards.py - Compliance Watch
agents/compliance_watch.py - Compliance State
data
Research Tools
- Signal Backtest
backtest.py - Momentum Rotation
rotation.py
Dashboard and Alerts
- Dashboard
dashboard/index.html - Dashboard Scan Data
dashboard
Other components
- Investor
- Symbol Watchlist
watchlist.txt - Yahoo Finance
- Google News RSS
- GitHub Issues
Connections 26
- Investor → Symbol Watchlist: edits symbols
- Symbol Watchlist → Scan Pipeline: loads symbols
- Scan Pipeline → Shariah Screener: screens first
- Shariah Screener → Screening Standards: applies rules
- Shariah Screener → Crypto Allowlist: checks pairs
- Shariah Screener → Yahoo Finance: fetches fundamentals
- Scan Pipeline → Technical Agents: runs for HALAL
- Scan Pipeline → News Scanner: fetches headlines
- News Scanner → Google News RSS: requests feeds
- Technical Agents → Yahoo Finance: fetches market data
- Scan Pipeline → Recommendation Advisor: consolidates results
- Recommendation Advisor → Advisor Configuration: loads settings
- Scan Pipeline → Signal Learning Loop: records recommendations
- Signal Learning Loop → Learning History: reads and writes
- Signal Learning Loop → Yahoo Finance: fetches closes
- Scan Pipeline → Compliance Watch: updates screening state
- Compliance Watch → Compliance State: reads and writes
- Compliance Watch → GitHub Issues: opens alert issue
- Recommendation Advisor → Trade Executor: passes recommendations
- Trade Executor → Execution Risk Guards: checks trade
- Trade Executor → Yahoo Finance: fetches current price
- Signal Backtest → Momentum Rotation: runs rotation test
- Signal Backtest → Yahoo Finance: fetches history
- Scan Pipeline → Dashboard Scan Data: writes scan data
- Dashboard → Dashboard Scan Data: loads scan results
- Dashboard → Investor: shows results