RubyGems - sqa - Versions diffs - 0.0.31 → 0.0.37 - Mend

sqa 0.0.31 → 0.0.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (134) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +104 -0
data/CLAUDE.md +21 -0
data/README.md +60 -32
data/Rakefile +52 -10
data/docs/IMPROVEMENT_PLAN.md +531 -0
data/docs/advanced/index.md +1 -13
data/docs/api/dataframe.md +0 -1
data/docs/api/index.md +547 -61
data/docs/api-reference/alphavantageapi.md +1057 -0
data/docs/api-reference/apierror.md +31 -0
data/docs/api-reference/index.md +221 -0
data/docs/api-reference/notimplemented.md +27 -0
data/docs/api-reference/sqa.md +267 -0
data/docs/api-reference/sqa_backtest.md +137 -0
data/docs/api-reference/sqa_backtest_results.md +530 -0
data/docs/api-reference/sqa_badparametererror.md +13 -0
data/docs/api-reference/sqa_config.md +538 -0
data/docs/api-reference/sqa_configurationerror.md +13 -0
data/docs/api-reference/sqa_datafetcherror.md +56 -0
data/docs/api-reference/sqa_dataframe.md +752 -0
data/docs/api-reference/sqa_dataframe_alphavantage.md +30 -0
data/docs/api-reference/sqa_dataframe_data.md +325 -0
data/docs/api-reference/sqa_dataframe_yahoofinance.md +25 -0
data/docs/api-reference/sqa_ensemble.md +413 -0
data/docs/api-reference/sqa_fpop.md +211 -0
data/docs/api-reference/sqa_geneticprogram.md +325 -0
data/docs/api-reference/sqa_geneticprogram_individual.md +114 -0
data/docs/api-reference/sqa_marketregime.md +212 -0
data/docs/api-reference/sqa_multitimeframe.md +227 -0
data/docs/api-reference/sqa_patternmatcher.md +195 -0
data/docs/api-reference/sqa_pluginmanager.md +55 -0
data/docs/api-reference/sqa_portfolio.md +455 -0
data/docs/api-reference/sqa_portfolio_position.md +220 -0
data/docs/api-reference/sqa_portfolio_trade.md +332 -0
data/docs/api-reference/sqa_portfoliooptimizer.md +248 -0
data/docs/api-reference/sqa_riskmanager.md +388 -0
data/docs/api-reference/sqa_seasonalanalyzer.md +121 -0
data/docs/api-reference/sqa_sectoranalyzer.md +163 -0
data/docs/api-reference/sqa_stock.md +649 -0
data/docs/api-reference/sqa_strategy.md +178 -0
data/docs/api-reference/sqa_strategy_bollingerbands.md +26 -0
data/docs/api-reference/sqa_strategy_common.md +29 -0
data/docs/api-reference/sqa_strategy_consensus.md +129 -0
data/docs/api-reference/sqa_strategy_ema.md +41 -0
data/docs/api-reference/sqa_strategy_kbs.md +154 -0
data/docs/api-reference/sqa_strategy_macd.md +26 -0
data/docs/api-reference/sqa_strategy_mp.md +41 -0
data/docs/api-reference/sqa_strategy_mr.md +41 -0
data/docs/api-reference/sqa_strategy_random.md +41 -0
data/docs/api-reference/sqa_strategy_rsi.md +41 -0
data/docs/api-reference/sqa_strategy_sma.md +41 -0
data/docs/api-reference/sqa_strategy_stochastic.md +26 -0
data/docs/api-reference/sqa_strategy_volumebreakout.md +26 -0
data/docs/api-reference/sqa_strategygenerator.md +298 -0
data/docs/api-reference/sqa_strategygenerator_pattern.md +264 -0
data/docs/api-reference/sqa_strategygenerator_patterncontext.md +326 -0
data/docs/api-reference/sqa_strategygenerator_profitablepoint.md +424 -0
data/docs/api-reference/sqa_stream.md +256 -0
data/docs/api-reference/sqa_ticker.md +175 -0
data/docs/api-reference/string.md +135 -0
data/docs/assets/images/advanced-workflow.svg +89 -0
data/docs/assets/images/architecture.svg +107 -0
data/docs/assets/images/data-flow.svg +138 -0
data/docs/assets/images/getting-started-workflow.svg +88 -0
data/docs/assets/images/sqa.jpg +0 -0
data/docs/assets/images/strategy-flow.svg +78 -0
data/docs/assets/images/system-architecture.svg +150 -0
data/docs/concepts/index.md +292 -27
data/docs/data_frame.md +0 -1
data/docs/getting-started/index.md +1 -30
data/docs/getting-started/installation.md +2 -2
data/docs/getting-started/quick-start.md +4 -4
data/docs/index.md +26 -25
data/docs/llms.txt +109 -0
data/docs/strategies/bollinger-bands.md +1 -1
data/docs/strategies/kbs.md +15 -14
data/docs/strategies/rsi.md +1 -1
data/docs/strategy.md +381 -3
data/docs/terms_of_use.md +1 -1
data/examples/README.md +10 -0
data/lib/api/alpha_vantage_api.rb +3 -7
data/lib/sqa/config.rb +109 -28
data/lib/sqa/data_frame/alpha_vantage.rb +13 -3
data/lib/sqa/data_frame/data.rb +13 -1
data/lib/sqa/data_frame.rb +189 -41
data/lib/sqa/errors.rb +79 -17
data/lib/sqa/indicator.rb +17 -4
data/lib/sqa/init.rb +70 -15
data/lib/sqa/pattern_matcher.rb +4 -4
data/lib/sqa/portfolio.rb +1 -1
data/lib/sqa/sector_analyzer.rb +3 -11
data/lib/sqa/stock.rb +236 -20
data/lib/sqa/strategy.rb +62 -4
data/lib/sqa/ticker.rb +107 -42
data/lib/sqa/version.rb +1 -1
data/lib/sqa.rb +16 -8
data/mkdocs.yml +68 -117
metadata +90 -36
data/docs/README.md +0 -43
data/docs/alpha_vantage_technical_indicators.md +0 -62
data/docs/average_true_range.md +0 -9
data/docs/bollinger_bands.md +0 -15
data/docs/candlestick_pattern_recognizer.md +0 -4
data/docs/donchian_channel.md +0 -5
data/docs/double_top_bottom_pattern.md +0 -3
data/docs/exponential_moving_average.md +0 -19
data/docs/fibonacci_retracement.md +0 -30
data/docs/head_and_shoulders_pattern.md +0 -3
data/docs/market_profile.md +0 -4
data/docs/momentum.md +0 -19
data/docs/moving_average_convergence_divergence.md +0 -23
data/docs/peaks_and_valleys.md +0 -11
data/docs/relative_strength_index.md +0 -6
data/docs/simple_moving_average.md +0 -8
data/docs/stochastic_oscillator.md +0 -4
data/docs/ta_lib.md +0 -160
data/docs/true_range.md +0 -12
data/docs/true_strength_index.md +0 -46
data/docs/weighted_moving_average.md +0 -48
data/examples/sinatra_app/Gemfile +0 -22
data/examples/sinatra_app/QUICKSTART.md +0 -159
data/examples/sinatra_app/README.md +0 -461
data/examples/sinatra_app/app.rb +0 -344
data/examples/sinatra_app/config.ru +0 -5
data/examples/sinatra_app/public/css/style.css +0 -659
data/examples/sinatra_app/public/js/app.js +0 -107
data/examples/sinatra_app/views/analyze.erb +0 -306
data/examples/sinatra_app/views/backtest.erb +0 -325
data/examples/sinatra_app/views/dashboard.erb +0 -419
data/examples/sinatra_app/views/error.erb +0 -58
data/examples/sinatra_app/views/index.erb +0 -118
data/examples/sinatra_app/views/layout.erb +0 -61
data/examples/sinatra_app/views/portfolio.erb +0 -43

data/docs/api-reference/sqa_backtest_results.md ADDED Viewed

@@ -0,0 +1,530 @@
+# 📦 SQA::Backtest::Results
+!!! note "Description"
+    Represents the results of a backtest
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/backtest.rb:11`
+    **Inherits from:** `Object`
+## 🔨 Instance Methods
+### `#total_return()`
+Returns the value of attribute total_return.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#total_return=(value)`
+Sets the attribute total_return
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute total_return to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#annualized_return()`
+Returns the value of attribute annualized_return.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#annualized_return=(value)`
+Sets the attribute annualized_return
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute annualized_return to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#sharpe_ratio()`
+Returns the value of attribute sharpe_ratio.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#sharpe_ratio=(value)`
+Sets the attribute sharpe_ratio
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute sharpe_ratio to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#max_drawdown()`
+Returns the value of attribute max_drawdown.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#max_drawdown=(value)`
+Sets the attribute max_drawdown
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute max_drawdown to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#total_trades()`
+Returns the value of attribute total_trades.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#total_trades=(value)`
+Sets the attribute total_trades
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute total_trades to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#winning_trades()`
+Returns the value of attribute winning_trades.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#winning_trades=(value)`
+Sets the attribute winning_trades
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute winning_trades to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#losing_trades()`
+Returns the value of attribute losing_trades.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#losing_trades=(value)`
+Sets the attribute losing_trades
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute losing_trades to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#win_rate()`
+Returns the value of attribute win_rate.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#win_rate=(value)`
+Sets the attribute win_rate
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute win_rate to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#average_win()`
+Returns the value of attribute average_win.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#average_win=(value)`
+Sets the attribute average_win
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute average_win to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#average_loss()`
+Returns the value of attribute average_loss.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#average_loss=(value)`
+Sets the attribute average_loss
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute average_loss to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#profit_factor()`
+Returns the value of attribute profit_factor.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#profit_factor=(value)`
+Sets the attribute profit_factor
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute profit_factor to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#start_date()`
+Returns the value of attribute start_date.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#start_date=(value)`
+Sets the attribute start_date
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute start_date to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#end_date()`
+Returns the value of attribute end_date.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#end_date=(value)`
+Sets the attribute end_date
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute end_date to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#initial_capital()`
+Returns the value of attribute initial_capital.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#initial_capital=(value)`
+Sets the attribute initial_capital
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute initial_capital to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#final_value()`
+Returns the value of attribute final_value.
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#final_value=(value)`
+Sets the attribute final_value
+!!! info "Parameters"
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute final_value to. |
+??? info "Source Location"
+    `lib/sqa/backtest.rb:12`
+---
+### `#initialize()`
+!!! success "Returns"
+    **Type:** `Results`
+    a new instance of Results
+??? info "Source Location"
+    `lib/sqa/backtest.rb:17`
+---
+### `#to_h()`
+??? info "Source Location"
+    `lib/sqa/backtest.rb:31`
+---
+### `#summary()`
+??? info "Source Location"
+    `lib/sqa/backtest.rb:51`
+---
+## 📝 Attributes
+### 🔄 `total_return` <small>read/write</small>
+Returns the value of attribute total_return.
+### 🔄 `annualized_return` <small>read/write</small>
+Returns the value of attribute annualized_return.
+### 🔄 `sharpe_ratio` <small>read/write</small>
+Returns the value of attribute sharpe_ratio.
+### 🔄 `max_drawdown` <small>read/write</small>
+Returns the value of attribute max_drawdown.
+### 🔄 `total_trades` <small>read/write</small>
+Returns the value of attribute total_trades.
+### 🔄 `winning_trades` <small>read/write</small>
+Returns the value of attribute winning_trades.
+### 🔄 `losing_trades` <small>read/write</small>
+Returns the value of attribute losing_trades.
+### 🔄 `win_rate` <small>read/write</small>
+Returns the value of attribute win_rate.
+### 🔄 `average_win` <small>read/write</small>
+Returns the value of attribute average_win.
+### 🔄 `average_loss` <small>read/write</small>
+Returns the value of attribute average_loss.
+### 🔄 `profit_factor` <small>read/write</small>
+Returns the value of attribute profit_factor.
+### 🔄 `start_date` <small>read/write</small>
+Returns the value of attribute start_date.
+### 🔄 `end_date` <small>read/write</small>
+Returns the value of attribute end_date.
+### 🔄 `initial_capital` <small>read/write</small>
+Returns the value of attribute initial_capital.
+### 🔄 `final_value` <small>read/write</small>
+Returns the value of attribute final_value.

data/docs/api-reference/sqa_badparametererror.md ADDED Viewed

@@ -0,0 +1,13 @@
+# 📦 SQA::BadParameterError
+!!! note "Description"
+    Raised when a method parameter is invalid.
+    Inherits from ArgumentError for semantic clarity.
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/errors.rb:54`
+    **Inherits from:** `ArgumentError`
+## 📝 Attributes