quantmini/.env.example at main · nittygritty-zzy/quantmini · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# Environment Variables for QuantMini Pipeline
# Copy this file to .env and customize for your environment

# ============================================================================
# DATA PATHS
# ============================================================================
# Root directory for data lake (bronze/silver/gold layers)
# Used by daily_update.sh and transform commands
# Default: $HOME/quantlake
# Examples:
#   - External drive on macOS: /Volumes/sandisk/quantlake
#   - External drive on Linux: /mnt/storage/quantlake
#   - Home directory: ~/quantlake
QUANTLAKE_ROOT=~/quantlake

# Root directory for all data storage (parquet, qlib, metadata, cache)
# This should point to a fast storage location (SSD recommended)
# Examples:
#   - External drive on macOS: /Volumes/sandisk/quantlake
#   - External drive on Linux: /mnt/storage/quantlake
#   - Default (current directory): ./data
DATA_ROOT=./data

# ============================================================================
# PIPELINE CONFIGURATION
# ============================================================================
# Processing mode: adaptive, streaming, batch, or parallel
# 'adaptive' auto-selects based on system capabilities (recommended)
PIPELINE_MODE=adaptive

# Log level: DEBUG, INFO, WARNING, ERROR, CRITICAL
LOG_LEVEL=INFO

# Maximum memory usage in GB (override auto-detection)
# MAX_MEMORY_GB=20

# ============================================================================
# POLYGON.IO CREDENTIALS
# ============================================================================
# Your Polygon.io API key (required for REST API data refresh)
# Get your key from: https://polygon.io/dashboard/api-keys
POLYGON_API_KEY=your_api_key_here

# Note: S3 flat files credentials are configured in config/credentials.yaml
# The API key here is used for REST API endpoints (quantmini api commands)

# ============================================================================
# OPTIONAL OVERRIDES
# ============================================================================
# Override config directory (default: ./config)
# CONFIG_ROOT=./config

# Override log directory (default: ./logs)
# LOG_ROOT=./logs

# Override max workers for parallel processing
# MAX_WORKERS=8

# Override chunk size for streaming mode
# CHUNK_SIZE=10000