sqa 0.0.37 → 0.0.38
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +62 -0
- data/docs/api-reference/alphavantageapi.md +105 -105
- data/docs/api-reference/apierror.md +2 -2
- data/docs/api-reference/index.md +2 -2
- data/docs/api-reference/notimplemented.md +2 -2
- data/docs/api-reference/sqa.md +12 -12
- data/docs/api-reference/sqa_backtest.md +43 -9
- data/docs/api-reference/sqa_backtest_results.md +34 -34
- data/docs/api-reference/sqa_badparametererror.md +1 -1
- data/docs/api-reference/sqa_config.md +31 -31
- data/docs/api-reference/sqa_configurationerror.md +1 -1
- data/docs/api-reference/sqa_datafetcherror.md +3 -3
- data/docs/api-reference/sqa_dataframe.md +63 -36
- data/docs/api-reference/sqa_dataframe_alphavantage.md +2 -2
- data/docs/api-reference/sqa_dataframe_data.md +18 -18
- data/docs/api-reference/sqa_dataframe_yahoofinance.md +2 -2
- data/docs/api-reference/sqa_ensemble.md +21 -21
- data/docs/api-reference/sqa_fpop.md +8 -8
- data/docs/api-reference/sqa_geneticprogram.md +20 -20
- data/docs/api-reference/sqa_geneticprogram_individual.md +8 -8
- data/docs/api-reference/sqa_marketregime.md +10 -10
- data/docs/api-reference/sqa_multitimeframe.md +11 -11
- data/docs/api-reference/sqa_patternmatcher.md +9 -9
- data/docs/api-reference/sqa_pluginmanager.md +4 -4
- data/docs/api-reference/sqa_portfolio.md +84 -27
- data/docs/api-reference/sqa_portfolio_position.md +12 -12
- data/docs/api-reference/sqa_portfolio_trade.md +16 -16
- data/docs/api-reference/sqa_portfoliooptimizer.md +10 -10
- data/docs/api-reference/sqa_riskmanager.md +12 -12
- data/docs/api-reference/sqa_seasonalanalyzer.md +6 -6
- data/docs/api-reference/sqa_sectoranalyzer.md +9 -9
- data/docs/api-reference/sqa_stock.md +48 -36
- data/docs/api-reference/sqa_strategy.md +8 -8
- data/docs/api-reference/sqa_strategy_bollingerbands.md +2 -2
- data/docs/api-reference/sqa_strategy_common.md +3 -3
- data/docs/api-reference/sqa_strategy_consensus.md +12 -12
- data/docs/api-reference/sqa_strategy_ema.md +4 -4
- data/docs/api-reference/sqa_strategy_kbs.md +11 -11
- data/docs/api-reference/sqa_strategy_macd.md +2 -2
- data/docs/api-reference/sqa_strategy_mp.md +4 -4
- data/docs/api-reference/sqa_strategy_mr.md +4 -4
- data/docs/api-reference/sqa_strategy_random.md +4 -4
- data/docs/api-reference/sqa_strategy_rsi.md +4 -4
- data/docs/api-reference/sqa_strategy_sma.md +4 -4
- data/docs/api-reference/sqa_strategy_stochastic.md +2 -2
- data/docs/api-reference/sqa_strategy_volumebreakout.md +2 -2
- data/docs/api-reference/sqa_strategygenerator.md +19 -19
- data/docs/api-reference/sqa_strategygenerator_pattern.md +17 -17
- data/docs/api-reference/sqa_strategygenerator_patterncontext.md +21 -21
- data/docs/api-reference/sqa_strategygenerator_profitablepoint.md +27 -27
- data/docs/api-reference/sqa_stream.md +18 -18
- data/docs/api-reference/sqa_ticker.md +8 -8
- data/docs/api-reference/string.md +11 -11
- data/docs/file_formats.md +250 -0
- data/lib/sqa/backtest.rb +32 -0
- data/lib/sqa/data_frame.rb +25 -0
- data/lib/sqa/portfolio.rb +54 -0
- data/lib/sqa/stock.rb +11 -0
- data/lib/sqa/version.rb +1 -1
- data/mkdocs.yml +1 -0
- metadata +2 -2
- data/docs/IMPROVEMENT_PLAN.md +0 -531
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 830fbff0a1f2441e67e9781a2996774575cf021440c787804d308cde4b1fd7d5
|
|
4
|
+
data.tar.gz: be89088467543c775860ba3eee54a68c9998c50a1043ade62334678bc9175b05
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3b592a70012e50b0199d70f7511c02bda585b9c5a410a142d2945ba7af2e85565d06ebbcd7d26ecdb540c203f00dec3f6e7234df6b53bb73c597d780ebaf371d
|
|
7
|
+
data.tar.gz: eab323c5c1c7531042729a952a3f66e1ed21d6da872a92fa8ffe3a68cf63e3ebf50f7d4b47fe436d1301b5573530ee4acc9d477bce9f969bfd077fbaa2b53918
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,67 @@
|
|
|
1
1
|
## [Unreleased]
|
|
2
2
|
|
|
3
|
+
## [0.0.39] - 2025-11-24
|
|
4
|
+
|
|
5
|
+
### Added
|
|
6
|
+
- **YARD Documentation Examples**:
|
|
7
|
+
- Added comprehensive usage examples to 15+ critical methods across core classes
|
|
8
|
+
- `SQA::Portfolio`: Examples for `#buy`, `#sell`, `#value`, `#summary` methods
|
|
9
|
+
- `SQA::Backtest`: Examples for `#run` method showing RSI strategy, custom date ranges, and equity curve access
|
|
10
|
+
- `SQA::Stock`: Examples for `#update` method with API metadata fetching
|
|
11
|
+
- `SQA::DataFrame`: Examples for `#concat_and_deduplicate!` and `#to_csv` methods
|
|
12
|
+
- All examples demonstrate real-world usage with expected outputs
|
|
13
|
+
|
|
14
|
+
- **File Formats Documentation**:
|
|
15
|
+
- Created comprehensive `docs/file_formats.md` documenting all CSV and JSON formats
|
|
16
|
+
- **Portfolio Positions CSV**: Schema and usage for `save_to_csv()` / `load_from_csv()`
|
|
17
|
+
- **Trade History CSV**: Schema and usage for `save_trades_to_csv()`
|
|
18
|
+
- **Stock Data CSV**: OHLCV format with critical TA-Lib ordering requirements
|
|
19
|
+
- **Stock Metadata JSON**: Company overview data structure
|
|
20
|
+
- **Configuration Files**: YAML/TOML format documentation
|
|
21
|
+
- Added to MkDocs navigation under User Guide > Core Concepts
|
|
22
|
+
|
|
23
|
+
### Changed
|
|
24
|
+
- **API Documentation Improvements**:
|
|
25
|
+
- Regenerated all 51+ API reference markdown files with new examples
|
|
26
|
+
- Examples now appear in purple Material Design admonition boxes
|
|
27
|
+
- Improved discoverability of common usage patterns
|
|
28
|
+
|
|
29
|
+
## [0.0.38] - 2025-11-24
|
|
30
|
+
|
|
31
|
+
### Added
|
|
32
|
+
- **Integrated YARD Documentation into MkDocs**:
|
|
33
|
+
- Created `bin/generate_api_docs.rb` script to convert YARD comments to markdown
|
|
34
|
+
- Generates 51+ API reference markdown files in `docs/api-reference/`
|
|
35
|
+
- Unified Material theme across all documentation pages
|
|
36
|
+
- Auto-generated documentation includes timestamp and complete class/module information
|
|
37
|
+
|
|
38
|
+
### Changed
|
|
39
|
+
- **Enhanced Documentation Formatting**:
|
|
40
|
+
- Markdown generation now uses Material Design admonitions (note, info, success, example)
|
|
41
|
+
- Added emojis for visual hierarchy (📦 classes, 🔧 modules, 🏭 class methods, 🔨 instance methods, 📝 attributes, 🔢 constants)
|
|
42
|
+
- Parameters displayed in formatted tables instead of lists
|
|
43
|
+
- Return values in green success boxes with type badges
|
|
44
|
+
- Usage examples in purple example boxes with proper syntax highlighting
|
|
45
|
+
- Collapsible source location sections to reduce visual clutter
|
|
46
|
+
- Attribute access indicators (🔄 read/write, 👁️ read-only, ✍️ write-only)
|
|
47
|
+
|
|
48
|
+
- **Simplified Rake Tasks**:
|
|
49
|
+
- Consolidated documentation tasks under `docs:` namespace
|
|
50
|
+
- `docs:build` - Generate API markdown from YARD + build MkDocs site
|
|
51
|
+
- `docs:serve` - Serve documentation locally with live reload
|
|
52
|
+
- `docs:clean` - Clean generated documentation files
|
|
53
|
+
- `docs:deploy` - Deploy to GitHub Pages
|
|
54
|
+
- Removed legacy tasks: `yard`, `yard_server`, `api_docs`
|
|
55
|
+
|
|
56
|
+
- **Documentation Visual Improvements**:
|
|
57
|
+
- Updated `docs/index.md` with flexbox layout (logo left, features right)
|
|
58
|
+
- Converted 6 mermaid diagrams to colorful SVG images with transparent backgrounds
|
|
59
|
+
- High-contrast colors for better readability
|
|
60
|
+
- Added namespace icons (🎯 SQA, 📊 strategies) in API index
|
|
61
|
+
|
|
62
|
+
### Dependencies
|
|
63
|
+
- Added `yard` and `yard-markdown` gems for API documentation generation
|
|
64
|
+
|
|
3
65
|
## [0.0.36] - 2025-11-24
|
|
4
66
|
|
|
5
67
|
### Changed
|