sqa 0.0.24 → 0.0.31

data/docs/api/index.md

@@ -0,0 +1,126 @@
+# API Reference
+
+Complete API documentation for SQA classes and modules.
+
+## Core Classes
+
+### SQA Module
+Main module containing configuration and initialization.
+
+- `SQA.init` - Initialize SQA system
+- `SQA.config` - Access configuration
+- `SQA.data_dir` - Get data directory
+- `SQA.av` - Alpha Vantage API client
+
+### Stock Class
+Represents a stock with historical data.
+
+```ruby
+stock = SQA::Stock.new(ticker: 'AAPL')
+```
+
+**Methods:**
+- `#ticker` - Stock symbol
+- `#df` - DataFrame with price/volume data
+- `#update` - Fetch latest data
+- `#save_data` - Persist to disk
+
+### DataFrame Class
+High-performance wrapper around Polars DataFrame.
+
+```ruby
+df = stock.df
+prices = df["adj_close_price"].to_a
+```
+
+**Methods:**
+- `#height` - Number of rows
+- `#column(name)` - Get column by name
+- `#head(n)` - First n rows
+- `#tail(n)` - Last n rows
+
+### Strategy Classes
+Base class for all trading strategies.
+
+```ruby
+signal = SQA::Strategy::RSI.trade(vector)
+```
+
+**Common Interface:**
+- `.trade(vector)` - Generate trading signal
+- `.trade_against(vector)` - Invert signal
+
+## Advanced Classes
+
+### Portfolio Class
+Track positions and calculate P&L.
+
+```ruby
+portfolio = SQA::Portfolio.new(initial_cash: 10_000)
+portfolio.buy('AAPL', shares: 10, price: 150.0)
+```
+
+### Backtest Class
+Simulate strategies on historical data.
+
+```ruby
+backtest = SQA::Backtest.new(stock: stock, strategy: SQA::Strategy::MACD)
+results = backtest.run
+```
+
+### Stream Class
+Process real-time price data.
+
+```ruby
+stream = SQA::Stream.new(ticker: 'AAPL', strategies: [SQA::Strategy::RSI])
+stream.on_signal { |signal, data| puts "Signal: #{signal}" }
+```
+
+## Indicator Functions (SQAI)
+
+All indicators from TA-Lib are available via the `SQAI` module.
+
+```ruby
+# Moving averages
+SQAI.sma(prices, period: 20)
+SQAI.ema(prices, period: 12)
+
+# Oscillators
+SQAI.rsi(prices, period: 14)
+SQAI.macd(prices, fast_period: 12, slow_period: 26, signal_period: 9)
+
+# Volatility
+SQAI.bbands(prices, period: 20, nbdev_up: 2, nbdev_down: 2)
+SQAI.atr(high, low, close, period: 14)
+```
+
+See the [full indicator list](../indicators/index.md).
+
+## Configuration
+
+### Config Class
+Manage SQA configuration.
+
+```ruby
+config = SQA::Config.new(data_dir: "~/my_data")
+```
+
+**Properties:**
+- `data_dir` - Data storage location
+- `log_level` - Logging verbosity
+- `debug` - Debug mode flag
+
+## Error Classes
+
+- `SQA::ApiError` - API request failures
+- `SQA::BadParameterError` - Invalid parameters
+- `SQA::NoDataError` - Missing data
+
+---
+
+For detailed documentation, see the source code or use Ruby's introspection:
+
+```ruby
+SQA::Stock.instance_methods(false)
+SQAI.methods.grep(/^[a-z]/).sort
+```

data/docs/assets/css/custom.css

@@ -0,0 +1,88 @@
+/* Custom styles for SQA documentation */
+
+:root {
+  --md-primary-fg-color: #3f51b5;
+  --md-accent-fg-color: #673ab7;
+}
+
+/* Enhanced code blocks */
+.highlight {
+  border-radius: 4px;
+}
+
+/* Better tables */
+table {
+  box-shadow: 0 2px 4px rgba(0,0,0,0.1);
+}
+
+/* Card styling for grid layouts */
+.md-typeset .grid.cards > * {
+  border: 1px solid var(--md-default-fg-color--lightest);
+  border-radius: 4px;
+  transition: all 0.2s ease-in-out;
+}
+
+.md-typeset .grid.cards > *:hover {
+  box-shadow: 0 4px 8px rgba(0,0,0,0.1);
+  transform: translateY(-2px);
+}
+
+/* Admonition enhancements */
+.admonition {
+  border-left-width: 4px;
+}
+
+/* Code inline emphasis */
+code {
+  background-color: var(--md-code-bg-color);
+  border-radius: 2px;
+  padding: 0.1em 0.3em;
+}
+
+/* Better h1 styling */
+.md-typeset h1 {
+  font-weight: 600;
+  letter-spacing: -0.02em;
+}
+
+/* Footer enhancement */
+.md-footer-meta {
+  background-color: var(--md-footer-bg-color);
+}
+
+/* Responsive images */
+.md-typeset img {
+  max-width: 100%;
+  height: auto;
+}
+
+/* Warning box for trading disclaimers */
+.md-typeset .admonition.warning {
+  border-left-color: #ff9800;
+}
+
+/* Success indicators */
+.md-typeset .admonition.tip {
+  border-left-color: #00c853;
+}
+
+/* Mermaid diagram styling */
+.mermaid {
+  text-align: center;
+  margin: 1em 0;
+}
+
+/* Better spacing for navigation tabs */
+.md-tabs {
+  border-bottom: 1px solid var(--md-default-fg-color--lightest);
+}
+
+/* Code copy button enhancement */
+.md-clipboard {
+  transition: opacity 0.2s;
+}
+
+/* Table of contents highlighting */
+.md-sidebar--secondary .md-nav__link--active {
+  font-weight: 600;
+}

data/docs/assets/js/mathjax.js

@@ -0,0 +1,18 @@
+// MathJax configuration for SQA documentation
+
+window.MathJax = {
+  tex: {
+    inlineMath: [["\\(", "\\)"]],
+    displayMath: [["\\[", "\\]"]],
+    processEscapes: true,
+    processEnvironments: true
+  },
+  options: {
+    ignoreHtmlClass: ".*|",
+    processHtmlClass: "arithmatex"
+  }
+};
+
+document$.subscribe(() => {
+  MathJax.typesetPromise()
+})

data/docs/concepts/index.md

@@ -0,0 +1,68 @@
+# Core Concepts
+
+Understanding the fundamental building blocks of SQA.
+
+## Overview
+
+SQA is built around several key concepts that work together to provide a comprehensive stock analysis framework:
+
+- **Stock Objects** - Represent individual stocks with historical data
+- **DataFrames** - High-performance time series data structures
+- **Technical Indicators** - Mathematical calculations on price/volume data
+- **Trading Strategies** - Rules for generating buy/sell/hold signals
+- **Portfolio Management** - Track positions and calculate P&L
+- **Backtesting** - Simulate strategies on historical data
+
+## Architecture Diagram
+
+```mermaid
+graph TB
+    A[Data Source] -->|Fetch| B[Stock Object]
+    B -->|Contains| C[DataFrame]
+    C -->|Calculate| D[Technical Indicators]
+    D -->|Feed| E[Trading Strategies]
+    E -->|Generate| F[Trading Signals]
+    F -->|Execute| G[Portfolio]
+    G -->|Track| H[Trades & P/L]
+
+    E -->|Test| I[Backtest]
+    I -->|Evaluate| J[Performance Metrics]
+```
+
+## Learn More
+
+<div class="grid cards" markdown>
+
+-   :material-chart-line:{ .lg .middle } __Stock Objects__
+
+    ---
+
+    Learn about loading and managing stock data
+
+    [:octicons-arrow-right-24: Stock Guide](stock.md)
+
+-   :material-table:{ .lg .middle } __DataFrames__
+
+    ---
+
+    High-performance data structures powered by Polars
+
+    [:octicons-arrow-right-24: DataFrame Guide](../data_frame.md)
+
+-   :material-chart-bell-curve:{ .lg .middle } __Indicators__
+
+    ---
+
+    150+ technical analysis indicators via TA-Lib
+
+    [:octicons-arrow-right-24: Indicators](indicators.md)
+
+-   :material-strategy:{ .lg .middle } __Strategies__
+
+    ---
+
+    Framework for creating and executing trading strategies
+
+    [:octicons-arrow-right-24: Strategies](../strategy.md)
+
+</div>

data/docs/contributing/index.md

@@ -0,0 +1,60 @@
+# Contributing to SQA
+
+Thank you for your interest in contributing to SQA!
+
+## Ways to Contribute
+
+- Report bugs
+- Suggest features
+- Improve documentation
+- Submit pull requests
+- Write tests
+
+## Getting Started
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run tests
+5. Submit a pull request
+
+## Development Setup
+
+```bash
+git clone https://github.com/madbomber/sqa.git
+cd sqa
+bundle install
+```
+
+## Running Tests
+
+```bash
+# Run all tests
+rake test
+
+# Run specific test file
+ruby -Ilib:test test/strategy/rsi_test.rb
+
+# With coverage
+rake test
+open coverage/index.html
+```
+
+## Code Style
+
+- Follow Ruby community style guidelines
+- Use meaningful variable names
+- Add comments for complex logic
+- Keep methods focused and small
+
+## Pull Request Process
+
+1. Update documentation
+2. Add tests for new features
+3. Ensure all tests pass
+4. Update CHANGELOG.md
+5. Submit PR with clear description
+
+## Questions?
+
+Open an issue on GitHub or start a discussion.

data/docs/data-sources/index.md

@@ -0,0 +1,66 @@
+# Data Sources
+
+SQA supports multiple data sources for historical stock price data.
+
+## Available Data Sources
+
+### Alpha Vantage (Primary)
+Free API with generous limits for historical and real-time data.
+
+**Setup:**
+```bash
+export AV_API_KEY="your_key_here"
+```
+
+**Features:**
+- Daily historical data
+- Adjusted closing prices
+- Up to 20 years of history
+- API key required (free)
+
+[Get API Key →](https://www.alphavantage.co/support/#api-key)
+
+### Yahoo Finance (Fallback)
+Web scraping fallback for when Alpha Vantage is unavailable.
+
+**Features:**
+- No API key required
+- Less reliable (web scraping)
+- Good for testing
+
+### CSV Files (Custom)
+Import your own data from CSV files.
+
+**Format:**
+```csv
+Date,Open,High,Low,Close,Adj Close,Volume
+2024-01-01,150.0,152.0,149.0,151.0,151.0,1000000
+```
+
+Place CSV files in `~/sqa_data/` named as `{ticker}.csv`.
+
+## Data Format
+
+SQA uses a standardized column format:
+
+- `timestamp` - Date of trading day
+- `open_price` - Opening price
+- `high_price` - Highest price
+- `low_price` - Lowest price
+- `close_price` - Closing price
+- `adj_close_price` - Adjusted closing price
+- `volume` - Trading volume
+
+## Configuration
+
+Set data directory in config:
+
+```ruby
+SQA.config.data_dir = "/path/to/data"
+```
+
+Or via environment:
+
+```bash
+export SQA_DATA_DIR="/path/to/data"
+```