sqa 0.0.32 → 0.0.38

data/docs/api-reference/sqa_strategygenerator_profitablepoint.md

@@ -0,0 +1,424 @@
+# 📦 SQA::StrategyGenerator::ProfitablePoint
+
+!!! note "Description"
+    Represents a profitable trade opportunity discovered in historical data
+
+!!! abstract "Source Information"
+    **Defined in:** [`lib/sqa/strategy_generator.rb:38`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L38)
+    
+    **Inherits from:** `Object`
+
+## 🔨 Instance Methods
+
+### `#entry_index()`
+
+Returns the value of attribute entry_index.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#entry_index=(value)`
+
+Sets the attribute entry_index
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute entry_index to. |
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#entry_price()`
+
+Returns the value of attribute entry_price.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#entry_price=(value)`
+
+Sets the attribute entry_price
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute entry_price to. |
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#exit_index()`
+
+Returns the value of attribute exit_index.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#exit_index=(value)`
+
+Sets the attribute exit_index
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute exit_index to. |
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#exit_price()`
+
+Returns the value of attribute exit_price.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#exit_price=(value)`
+
+Sets the attribute exit_price
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute exit_price to. |
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#gain_percent()`
+
+Returns the value of attribute gain_percent.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#gain_percent=(value)`
+
+Sets the attribute gain_percent
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute gain_percent to. |
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#holding_days()`
+
+Returns the value of attribute holding_days.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#holding_days=(value)`
+
+Sets the attribute holding_days
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute holding_days to. |
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#indicators()`
+
+Returns the value of attribute indicators.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#indicators=(value)`
+
+Sets the attribute indicators
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute indicators to. |
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#fpl_min_delta()`
+
+Returns the value of attribute fpl_min_delta.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#fpl_min_delta=(value)`
+
+Sets the attribute fpl_min_delta
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute fpl_min_delta to. |
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#fpl_max_delta()`
+
+Returns the value of attribute fpl_max_delta.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#fpl_max_delta=(value)`
+
+Sets the attribute fpl_max_delta
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute fpl_max_delta to. |
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#fpl_risk()`
+
+Returns the value of attribute fpl_risk.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#fpl_risk=(value)`
+
+Sets the attribute fpl_risk
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute fpl_risk to. |
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#fpl_direction()`
+
+Returns the value of attribute fpl_direction.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#fpl_direction=(value)`
+
+Sets the attribute fpl_direction
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute fpl_direction to. |
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#fpl_magnitude()`
+
+Returns the value of attribute fpl_magnitude.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#fpl_magnitude=(value)`
+
+Sets the attribute fpl_magnitude
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute fpl_magnitude to. |
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L39)
+
+---
+
+### `#initialize(entry_index:, entry_price:, exit_index:, exit_price:, fpl_data: = nil)`
+
+
+!!! success "Returns"
+
+    **Type:** `ProfitablePoint`
+
+    
+
+    a new instance of ProfitablePoint
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:43`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L43)
+
+---
+
+### `#to_s()`
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/strategy_generator.rb:62`](https://github.com/madbomber/sqa/blob/main/lib/sqa/strategy_generator.rb#L62)
+
+---
+
+## 📝 Attributes
+
+### 🔄 `entry_index` <small>read/write</small>
+
+Returns the value of attribute entry_index.
+
+### 🔄 `entry_price` <small>read/write</small>
+
+Returns the value of attribute entry_price.
+
+### 🔄 `exit_index` <small>read/write</small>
+
+Returns the value of attribute exit_index.
+
+### 🔄 `exit_price` <small>read/write</small>
+
+Returns the value of attribute exit_price.
+
+### 🔄 `gain_percent` <small>read/write</small>
+
+Returns the value of attribute gain_percent.
+
+### 🔄 `holding_days` <small>read/write</small>
+
+Returns the value of attribute holding_days.
+
+### 🔄 `indicators` <small>read/write</small>
+
+Returns the value of attribute indicators.
+
+### 🔄 `fpl_min_delta` <small>read/write</small>
+
+Returns the value of attribute fpl_min_delta.
+
+### 🔄 `fpl_max_delta` <small>read/write</small>
+
+Returns the value of attribute fpl_max_delta.
+
+### 🔄 `fpl_risk` <small>read/write</small>
+
+Returns the value of attribute fpl_risk.
+
+### 🔄 `fpl_direction` <small>read/write</small>
+
+Returns the value of attribute fpl_direction.
+
+### 🔄 `fpl_magnitude` <small>read/write</small>
+
+Returns the value of attribute fpl_magnitude.
+

data/docs/api-reference/sqa_stream.md

@@ -0,0 +1,256 @@
+# 📦 SQA::Stream
+
+!!! abstract "Source Information"
+    **Defined in:** [`lib/sqa/stream.rb:39`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L39)
+    
+    **Inherits from:** `Object`
+
+## 🔨 Instance Methods
+
+### `#ticker()`
+
+Returns the value of attribute ticker.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:40`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L40)
+
+---
+
+### `#window_size()`
+
+Returns the value of attribute window_size.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:40`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L40)
+
+---
+
+### `#strategies()`
+
+Returns the value of attribute strategies.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:40`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L40)
+
+---
+
+### `#data_buffer()`
+
+Returns the value of attribute data_buffer.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:40`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L40)
+
+---
+
+### `#indicator_cache()`
+
+Returns the value of attribute indicator_cache.
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:40`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L40)
+
+---
+
+### `#initialize(ticker:, window_size: = 100, strategies: = [])`
+
+
+!!! success "Returns"
+
+    **Type:** `Stream`
+
+    
+
+    a new instance of Stream
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:42`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L42)
+
+---
+
+### `#add_strategy(strategy)`
+
+Add a strategy to the stream processor
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:65`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L65)
+
+---
+
+### `#on_signal(&block)`
+
+Register callback for trading signals
+
+Example:
+  stream.on_signal do |signal, data|
+    puts "#{signal.upcase} at $#{data[:price]}"
+  end
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:78`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L78)
+
+---
+
+### `#on_update(&block)`
+
+Register callback for price updates
+
+Example:
+  stream.on_update do |data|
+    puts "Price updated: $#{data[:price]}"
+  end
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:89`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L89)
+
+---
+
+### `#update(price:, volume: = nil, high: = nil, low: = nil, timestamp: = Time.now)`
+
+Update stream with new market data
+
+Required fields: price
+Optional fields: volume, high, low, timestamp
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:98`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L98)
+
+---
+
+### `#current_price()`
+
+Get current price
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:136`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L136)
+
+---
+
+### `#recent_prices(count = nil)`
+
+Get recent prices
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:141`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L141)
+
+---
+
+### `#recent_volumes(count = nil)`
+
+Get recent volumes
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:148`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L148)
+
+---
+
+### `#indicator(name, **options)`
+
+Calculate or retrieve cached indicator
+
+Example:
+  rsi = stream.indicator(:rsi, period: 14)
+  sma = stream.indicator(:sma, period: 20)
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:159`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L159)
+
+---
+
+### `#current_signal()`
+
+Get current trading signal from last strategy execution
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:177`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L177)
+
+---
+
+### `#stats()`
+
+Get statistics about the stream
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:182`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L182)
+
+---
+
+### `#reset()`
+
+Reset the stream (clear all data)
+
+
+
+
+??? info "Source Location"
+    [`lib/sqa/stream.rb:199`](https://github.com/madbomber/sqa/blob/main/lib/sqa/stream.rb#L199)
+
+---
+
+## 📝 Attributes
+
+### 👁️ `ticker` <small>read-only</small>
+
+Returns the value of attribute ticker.
+
+### 👁️ `window_size` <small>read-only</small>
+
+Returns the value of attribute window_size.
+
+### 👁️ `strategies` <small>read-only</small>
+
+Returns the value of attribute strategies.
+
+### 👁️ `data_buffer` <small>read-only</small>
+
+Returns the value of attribute data_buffer.
+
+### 👁️ `indicator_cache` <small>read-only</small>
+
+Returns the value of attribute indicator_cache.
+