sqa 0.0.31 → 0.0.37

data/docs/api-reference/apierror.md

@@ -0,0 +1,31 @@
+# 📦 ApiError
+
+!!! note "Description"
+    Raised when an external API returns an error response.
+    Automatically logs the error using debug_me before raising.
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/errors.rb:67`
+    
+    **Inherits from:** `RuntimeError`
+
+## 🏭 Class Methods
+
+### `.raise(why)`
+
+Raises an ApiError with debug logging.
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `why` | `String` | The error message from the API |
+
+
+??? info "Source Location"
+    `lib/sqa/errors.rb:72`
+
+---
+
+## 📝 Attributes
+

data/docs/api-reference/index.md

@@ -0,0 +1,221 @@
+# 📚 API Reference
+
+Complete API documentation for all SQA classes and modules.
+
+!!! tip "Auto-Generated Documentation"
+    This documentation is automatically generated from YARD comments in the source code.
+    Last updated: 2025-11-24 14:46:25
+
+## 🎯 SQA
+
+### [📦 **Backtest**](sqa_backtest.md)
+
+### [📦 **BadParameterError**](sqa_badparametererror.md)
+
+!!! abstract ""
+    Raised when a method parameter is invalid.
+
+### [📦 **Config**](sqa_config.md)
+
+!!! abstract ""
+    Configuration class for SQA settings.
+
+### [📦 **ConfigurationError**](sqa_configurationerror.md)
+
+!!! abstract ""
+    Raised when SQA configuration is invalid or missing.
+
+### [📦 **DataFetchError**](sqa_datafetcherror.md)
+
+!!! abstract ""
+    Raised when unable to fetch data from a data source (API, file, etc.).
+
+### [📦 **DataFrame**](sqa_dataframe.md)
+
+!!! abstract ""
+    The website financial.yahoo.com no longer supports an API.
+
+### [📦 **Ensemble**](sqa_ensemble.md)
+
+!!! abstract ""
+    Ensemble - Combine multiple trading strategies
+
+### [🔧 **FPOP**](sqa_fpop.md)
+
+### [📦 **GeneticProgram**](sqa_geneticprogram.md)
+
+### [🔧 **MarketRegime**](sqa_marketregime.md)
+
+### [📦 **MultiTimeframe**](sqa_multitimeframe.md)
+
+!!! abstract ""
+    MultiTimeframe - Analyze patterns across multiple timeframes
+
+### [📦 **PatternMatcher**](sqa_patternmatcher.md)
+
+!!! abstract ""
+    PatternMatcher - Find similar historical patterns
+
+### [📦 **PluginManager**](sqa_pluginmanager.md)
+
+### [📦 **Portfolio**](sqa_portfolio.md)
+
+### [📦 **PortfolioOptimizer**](sqa_portfoliooptimizer.md)
+
+!!! abstract ""
+    PortfolioOptimizer - Multi-objective portfolio optimization
+
+### [📦 **RiskManager**](sqa_riskmanager.md)
+
+!!! abstract ""
+    RiskManager - Comprehensive risk management and position sizing
+
+### [🔧 **SeasonalAnalyzer**](sqa_seasonalanalyzer.md)
+
+### [📦 **SectorAnalyzer**](sqa_sectoranalyzer.md)
+
+### [📦 **Stock**](sqa_stock.md)
+
+!!! abstract ""
+    Represents a stock with price history, metadata, and technical analysis capabilities.
+
+### [📦 **Strategy**](sqa_strategy.md)
+
+!!! abstract ""
+    This module needs to be extend'ed within
+
+### [📦 **StrategyGenerator**](sqa_strategygenerator.md)
+
+### [📦 **Stream**](sqa_stream.md)
+
+### [📦 **Ticker**](sqa_ticker.md)
+
+!!! abstract ""
+    sqa/lib/sqa/ticker.rb
+
+
+## 📦 SQA::GeneticProgram
+
+### [📦 **Individual**](sqa_geneticprogram_individual.md)
+
+!!! abstract ""
+    Represents an individual trading strategy with specific parameters
+
+
+## 📦 Top Level
+
+### [📦 **AlphaVantageAPI**](alphavantageapi.md)
+
+### [📦 **ApiError**](apierror.md)
+
+!!! abstract ""
+    Raised when an external API returns an error response.
+
+### [📦 **NotImplemented**](notimplemented.md)
+
+!!! abstract ""
+    Raised when a feature is not yet implemented.
+
+### [🔧 **SQA**](sqa.md)
+
+!!! abstract ""
+    Knowledge-Based Strategy using RETE Forward Chaining
+
+### [📦 **String**](string.md)
+
+!!! abstract ""
+    File:  string.rb
+
+
+## 📦 SQA::Backtest
+
+### [📦 **Results**](sqa_backtest_results.md)
+
+!!! abstract ""
+    Represents the results of a backtest
+
+
+## 📦 SQA::Portfolio
+
+### [📦 **Position**](sqa_portfolio_position.md)
+
+!!! abstract ""
+    Represents a single position in the portfolio
+
+### [📦 **Trade**](sqa_portfolio_trade.md)
+
+!!! abstract ""
+    Represents a single trade
+
+
+## 📊 SQA::Strategy
+
+### [📦 **BollingerBands**](sqa_strategy_bollingerbands.md)
+
+!!! abstract ""
+    Bollinger Bands trading strategy
+
+### [🔧 **Common**](sqa_strategy_common.md)
+
+### [📦 **Consensus**](sqa_strategy_consensus.md)
+
+### [📦 **EMA**](sqa_strategy_ema.md)
+
+### [📦 **KBS**](sqa_strategy_kbs.md)
+
+### [📦 **MACD**](sqa_strategy_macd.md)
+
+!!! abstract ""
+    MACD (Moving Average Convergence Divergence) crossover strategy
+
+### [📦 **MP**](sqa_strategy_mp.md)
+
+### [📦 **MR**](sqa_strategy_mr.md)
+
+### [📦 **RSI**](sqa_strategy_rsi.md)
+
+### [📦 **Random**](sqa_strategy_random.md)
+
+### [📦 **SMA**](sqa_strategy_sma.md)
+
+### [📦 **Stochastic**](sqa_strategy_stochastic.md)
+
+!!! abstract ""
+    Stochastic Oscillator crossover strategy
+
+### [📦 **VolumeBreakout**](sqa_strategy_volumebreakout.md)
+
+!!! abstract ""
+    Volume Breakout strategy
+
+
+## 📦 SQA::DataFrame
+
+### [📦 **AlphaVantage**](sqa_dataframe_alphavantage.md)
+
+### [📦 **Data**](sqa_dataframe_data.md)
+
+!!! abstract ""
+    Data class to store stock metadata
+
+### [📦 **YahooFinance**](sqa_dataframe_yahoofinance.md)
+
+
+## 📊 SQA::StrategyGenerator
+
+### [📦 **Pattern**](sqa_strategygenerator_pattern.md)
+
+!!! abstract ""
+    Represents a discovered indicator pattern
+
+### [📦 **PatternContext**](sqa_strategygenerator_patterncontext.md)
+
+!!! abstract ""
+    Pattern Context - metadata about when/where pattern is valid
+
+### [📦 **ProfitablePoint**](sqa_strategygenerator_profitablepoint.md)
+
+!!! abstract ""
+    Represents a profitable trade opportunity discovered in historical data
+
+

data/docs/api-reference/notimplemented.md

@@ -0,0 +1,27 @@
+# 📦 NotImplemented
+
+!!! note "Description"
+    Raised when a feature is not yet implemented.
+    Automatically logs using debug_me before raising.
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/errors.rb:84`
+    
+    **Inherits from:** `RuntimeError`
+
+## 🏭 Class Methods
+
+### `.raise()`
+
+Raises a NotImplemented error with debug logging.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/errors.rb:88`
+
+---
+
+## 📝 Attributes
+

data/docs/api-reference/sqa.md

@@ -0,0 +1,267 @@
+# 🔧 SQA
+
+!!! note "Description"
+    Knowledge-Based Strategy using RETE Forward Chaining
+    
+    This strategy uses a rule-based system with the RETE algorithm for
+    forward-chaining inference. It allows defining complex trading rules
+    that react to market conditions.
+    
+    The strategy asserts facts about market conditions (RSI, trends, volume, etc.)
+    and fires rules when patterns are matched.
+    
+    DSL Keywords:
+      - on        : Assert a condition (fact must exist)
+      - without   : Negated condition (fact must NOT exist)
+      - perform   : Define action to execute when rule fires
+      - execute   : Alias for perform
+      - action    : Alias for perform
+    
+    Example:
+      strategy = SQA::Strategy::KBS.new
+    
+      # Capture kb for use in perform blocks
+      kb = strategy.kb
+    
+      # Define custom rules using the DSL
+      strategy.add_rule :buy_oversold_uptrend do
+        on :rsi, { level: :oversold }
+        on :trend, { direction: :up }
+        without :position
+    
+        perform do
+          kb.assert(:signal, { action: :buy, confidence: :high })
+        end
+      end
+    
+      # Execute strategy
+      signal = strategy.trade(vector)
+    
+    Note: Use 'kb.assert' (not just 'assert') in perform blocks to access the knowledge base.
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/gp.rb:34`
+
+## 🏭 Class Methods
+
+### `.config=(value)`
+
+Sets the attribute config
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute config to. |
+
+
+??? info "Source Location"
+    `lib/sqa/init.rb:22`
+
+---
+
+### `.init(argv = ARGV)`
+
+Initializes the SQA library.
+Should be called once at application startup.
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `argv` | `Array<String>, String` | Command line arguments (default: ARGV) |
+!!! success "Returns"
+
+    **Type:** `SQA::Config`
+
+    
+
+    The configuration instance
+!!! example "Usage Examples"
+
+    ```ruby
+    SQA.init
+    SQA.init("--debug --verbose")
+    ```
+??? info "Source Location"
+    `lib/sqa/init.rb:34`
+
+---
+
+### `.av_api_key()`
+
+Returns the Alpha Vantage API key.
+Reads from AV_API_KEY or ALPHAVANTAGE_API_KEY environment variables.
+
+
+!!! success "Returns"
+
+    **Type:** `String`
+
+    
+
+    The API key
+
+??? info "Source Location"
+    `lib/sqa/init.rb:61`
+
+---
+
+### `.av_api_key=(key)`
+
+Sets the Alpha Vantage API key.
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `key` | `String` | The API key to set |
+!!! success "Returns"
+
+    **Type:** `String`
+
+    
+
+    The key that was set
+
+??? info "Source Location"
+    `lib/sqa/init.rb:70`
+
+---
+
+### `.av()`
+
+Legacy accessor for backward compatibility with SQA.av.key usage.
+
+
+!!! success "Returns"
+
+    **Type:** `SQA`
+
+    
+
+    Self, to allow SQA.av.key calls
+
+??? info "Source Location"
+    `lib/sqa/init.rb:77`
+
+---
+
+### `.key()`
+
+Returns the API key for compatibility with old SQA.av.key usage.
+
+
+!!! success "Returns"
+
+    **Type:** `String`
+
+    
+
+    The API key
+
+??? info "Source Location"
+    `lib/sqa/init.rb:85`
+
+---
+
+### `.debug?()`
+
+Returns whether debug mode is enabled.
+
+
+!!! success "Returns"
+
+    **Type:** `Boolean`
+
+    
+
+    true if debug mode is on
+
+??? info "Source Location"
+    `lib/sqa/init.rb:91`
+
+---
+
+### `.verbose?()`
+
+Returns whether verbose mode is enabled.
+
+
+!!! success "Returns"
+
+    **Type:** `Boolean`
+
+    
+
+    true if verbose mode is on
+
+??? info "Source Location"
+    `lib/sqa/init.rb:95`
+
+---
+
+### `.homify(filepath)`
+
+Expands ~ to user's home directory in filepath.
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `filepath` | `String` | Path potentially containing ~ |
+!!! success "Returns"
+
+    **Type:** `String`
+
+    
+
+    Path with ~ expanded
+
+??? info "Source Location"
+    `lib/sqa/init.rb:101`
+
+---
+
+### `.data_dir()`
+
+Returns the data directory as a Pathname.
+
+
+!!! success "Returns"
+
+    **Type:** `Pathname`
+
+    
+
+    Data directory path
+
+??? info "Source Location"
+    `lib/sqa/init.rb:106`
+
+---
+
+### `.config()`
+
+Returns the current configuration.
+
+
+!!! success "Returns"
+
+    **Type:** `SQA::Config`
+
+    
+
+    Configuration instance
+
+??? info "Source Location"
+    `lib/sqa/init.rb:111`
+
+---
+
+## 📝 Attributes
+
+### 🔄 `config` <small>read/write</small>
+
+Returns the current configuration.
+

data/docs/api-reference/sqa_backtest.md

@@ -0,0 +1,137 @@
+# 📦 SQA::Backtest
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/backtest.rb:7`
+    
+    **Inherits from:** `Object`
+
+## 🔨 Instance Methods
+
+### `#stock()`
+
+Returns the value of attribute stock.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:8`
+
+---
+
+### `#strategy()`
+
+Returns the value of attribute strategy.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:8`
+
+---
+
+### `#portfolio()`
+
+Returns the value of attribute portfolio.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:8`
+
+---
+
+### `#results()`
+
+Returns the value of attribute results.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:8`
+
+---
+
+### `#equity_curve()`
+
+Returns the value of attribute equity_curve.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:8`
+
+---
+
+### `#initialize(stock:, strategy:, start_date: = nil, end_date: = nil, initial_capital: = 10_000.0, commission: = 0.0, position_size: = :all_cash)`
+
+Initialize a backtest
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `stock` | `SQA::Stock` | Stock to backtest |
+    | `strategy` | `SQA::Strategy, Proc` | Strategy or callable that returns :buy, :sell, or :hold |
+    | `start_date` | `Date, String` | Start date for backtest |
+    | `end_date` | `Date, String` | End date for backtest |
+    | `initial_capital` | `Float` | Starting capital |
+    | `commission` | `Float` | Commission per trade |
+    | `position_size` | `Symbol, Float` | :all_cash or fraction of portfolio per trade |
+!!! success "Returns"
+
+    **Type:** `Backtest`
+
+    
+
+    a new instance of Backtest
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:85`
+
+---
+
+### `#run()`
+
+Run the backtest
+
+
+!!! success "Returns"
+
+    **Type:** `Results`
+
+    
+
+    Backtest results
+
+??? info "Source Location"
+    `lib/sqa/backtest.rb:102`
+
+---
+
+## 📝 Attributes
+
+### 👁️ `stock` <small>read-only</small>
+
+Returns the value of attribute stock.
+
+### 👁️ `strategy` <small>read-only</small>
+
+Returns the value of attribute strategy.
+
+### 👁️ `portfolio` <small>read-only</small>
+
+Returns the value of attribute portfolio.
+
+### 👁️ `results` <small>read-only</small>
+
+Returns the value of attribute results.
+
+### 👁️ `equity_curve` <small>read-only</small>
+
+Returns the value of attribute equity_curve.
+