sqa-tai 0.1.0
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 +7 -0
- data/.envrc +1 -0
- data/CHANGELOG.md +34 -0
- data/COMMITS.md +196 -0
- data/Gemfile +18 -0
- data/Gemfile.lock +71 -0
- data/LICENSE +21 -0
- data/README.md +290 -0
- data/Rakefile +13 -0
- data/lib/extensions/ta_lib_ffi.rb +154 -0
- data/lib/sqa/tai/version.rb +7 -0
- data/lib/sqa/tai.rb +1850 -0
- data/mkdocs.yml +179 -0
- data/ta-lib-license.md +26 -0
- metadata +158 -0
data/mkdocs.yml
ADDED
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
# MkDocs Configuration for SQA TAI Documentation
|
|
2
|
+
site_name: SQA TAI - Technical Analysis Indicators
|
|
3
|
+
site_description: Ruby wrapper for TA-Lib - 200+ Technical Analysis Indicators
|
|
4
|
+
site_author: Dewayne VanHoozer
|
|
5
|
+
site_url: https://madbomber.github.io/sqa-tai
|
|
6
|
+
copyright: Copyright © 2024 Dewayne VanHoozer
|
|
7
|
+
|
|
8
|
+
# Repository information
|
|
9
|
+
repo_name: madbomber/sqa-tai
|
|
10
|
+
repo_url: https://github.com/MadBomber/sqa-tai
|
|
11
|
+
edit_uri: edit/main/docs/
|
|
12
|
+
|
|
13
|
+
# Configuration
|
|
14
|
+
theme:
|
|
15
|
+
name: material
|
|
16
|
+
|
|
17
|
+
# Color scheme - Default to light mode
|
|
18
|
+
palette:
|
|
19
|
+
# Palette toggle for light mode (default)
|
|
20
|
+
- scheme: default
|
|
21
|
+
primary: blue
|
|
22
|
+
accent: blue
|
|
23
|
+
toggle:
|
|
24
|
+
icon: material/brightness-7
|
|
25
|
+
name: Switch to dark mode
|
|
26
|
+
|
|
27
|
+
# Palette toggle for dark mode
|
|
28
|
+
- scheme: slate
|
|
29
|
+
primary: blue
|
|
30
|
+
accent: blue
|
|
31
|
+
toggle:
|
|
32
|
+
icon: material/brightness-4
|
|
33
|
+
name: Switch to light mode
|
|
34
|
+
|
|
35
|
+
# Typography
|
|
36
|
+
font:
|
|
37
|
+
text: Roboto
|
|
38
|
+
code: Roboto Mono
|
|
39
|
+
|
|
40
|
+
# Theme features
|
|
41
|
+
features:
|
|
42
|
+
# Navigation
|
|
43
|
+
- navigation.instant
|
|
44
|
+
- navigation.tracking
|
|
45
|
+
- navigation.tabs
|
|
46
|
+
- navigation.tabs.sticky
|
|
47
|
+
- navigation.sections
|
|
48
|
+
- navigation.path
|
|
49
|
+
- navigation.indexes
|
|
50
|
+
- navigation.top
|
|
51
|
+
|
|
52
|
+
# Table of contents
|
|
53
|
+
- toc.follow
|
|
54
|
+
|
|
55
|
+
# Search
|
|
56
|
+
- search.suggest
|
|
57
|
+
- search.highlight
|
|
58
|
+
- search.share
|
|
59
|
+
|
|
60
|
+
# Header
|
|
61
|
+
- header.autohide
|
|
62
|
+
|
|
63
|
+
# Content
|
|
64
|
+
- content.code.copy
|
|
65
|
+
- content.code.annotate
|
|
66
|
+
- content.tabs.link
|
|
67
|
+
- content.tooltips
|
|
68
|
+
- content.action.edit
|
|
69
|
+
- content.action.view
|
|
70
|
+
|
|
71
|
+
# Plugins
|
|
72
|
+
plugins:
|
|
73
|
+
- search:
|
|
74
|
+
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
|
|
75
|
+
|
|
76
|
+
# Extensions
|
|
77
|
+
markdown_extensions:
|
|
78
|
+
# Python Markdown
|
|
79
|
+
- abbr
|
|
80
|
+
- admonition
|
|
81
|
+
- attr_list
|
|
82
|
+
- def_list
|
|
83
|
+
- footnotes
|
|
84
|
+
- md_in_html
|
|
85
|
+
- toc:
|
|
86
|
+
permalink: true
|
|
87
|
+
title: On this page
|
|
88
|
+
|
|
89
|
+
# Python Markdown Extensions
|
|
90
|
+
- pymdownx.arithmatex:
|
|
91
|
+
generic: true
|
|
92
|
+
- pymdownx.betterem:
|
|
93
|
+
smart_enable: all
|
|
94
|
+
- pymdownx.caret
|
|
95
|
+
- pymdownx.details
|
|
96
|
+
- pymdownx.emoji:
|
|
97
|
+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
98
|
+
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
99
|
+
- pymdownx.highlight:
|
|
100
|
+
anchor_linenums: true
|
|
101
|
+
line_spans: __span
|
|
102
|
+
pygments_lang_class: true
|
|
103
|
+
- pymdownx.inlinehilite
|
|
104
|
+
- pymdownx.keys
|
|
105
|
+
- pymdownx.magiclink:
|
|
106
|
+
repo_url_shorthand: true
|
|
107
|
+
user: madbomber
|
|
108
|
+
repo: sqa-tai
|
|
109
|
+
- pymdownx.mark
|
|
110
|
+
- pymdownx.smartsymbols
|
|
111
|
+
- pymdownx.superfences:
|
|
112
|
+
custom_fences:
|
|
113
|
+
- name: mermaid
|
|
114
|
+
class: mermaid
|
|
115
|
+
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
116
|
+
- pymdownx.tabbed:
|
|
117
|
+
alternate_style: true
|
|
118
|
+
- pymdownx.tasklist:
|
|
119
|
+
custom_checkbox: true
|
|
120
|
+
- pymdownx.tilde
|
|
121
|
+
|
|
122
|
+
# Extra CSS and JavaScript
|
|
123
|
+
extra_css:
|
|
124
|
+
- assets/css/custom.css
|
|
125
|
+
|
|
126
|
+
extra_javascript:
|
|
127
|
+
- assets/js/mathjax.js
|
|
128
|
+
- https://polyfill.io/v3/polyfill.min.js?features=es6
|
|
129
|
+
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
|
|
130
|
+
|
|
131
|
+
# Social media and extra configuration
|
|
132
|
+
extra:
|
|
133
|
+
social:
|
|
134
|
+
- icon: fontawesome/brands/github
|
|
135
|
+
link: https://github.com/madbomber/sqa-tai
|
|
136
|
+
name: SQA TAI on GitHub
|
|
137
|
+
- icon: fontawesome/solid/gem
|
|
138
|
+
link: https://rubygems.org/gems/sqa-tai
|
|
139
|
+
name: SQA TAI on RubyGems
|
|
140
|
+
|
|
141
|
+
version:
|
|
142
|
+
provider: mike
|
|
143
|
+
|
|
144
|
+
# Navigation
|
|
145
|
+
nav:
|
|
146
|
+
- Home: index.md
|
|
147
|
+
- Getting Started:
|
|
148
|
+
- Installation: getting-started/installation.md
|
|
149
|
+
- Quick Start: getting-started/quick-start.md
|
|
150
|
+
- Basic Usage: getting-started/basic-usage.md
|
|
151
|
+
- Indicators:
|
|
152
|
+
- Overview: indicators/index.md
|
|
153
|
+
- Overlap Studies:
|
|
154
|
+
- Simple Moving Average: indicators/overlap/sma.md
|
|
155
|
+
- Exponential Moving Average: indicators/overlap/ema.md
|
|
156
|
+
- Weighted Moving Average: indicators/overlap/wma.md
|
|
157
|
+
- Bollinger Bands: indicators/overlap/bbands.md
|
|
158
|
+
- Momentum:
|
|
159
|
+
- RSI: indicators/momentum/rsi.md
|
|
160
|
+
- MACD: indicators/momentum/macd.md
|
|
161
|
+
- Stochastic: indicators/momentum/stoch.md
|
|
162
|
+
- Momentum: indicators/momentum/mom.md
|
|
163
|
+
- Volatility:
|
|
164
|
+
- Average True Range: indicators/volatility/atr.md
|
|
165
|
+
- True Range: indicators/volatility/trange.md
|
|
166
|
+
- Volume:
|
|
167
|
+
- On Balance Volume: indicators/volume/obv.md
|
|
168
|
+
- Chaikin A/D Line: indicators/volume/ad.md
|
|
169
|
+
- Patterns:
|
|
170
|
+
- Overview: indicators/patterns/index.md
|
|
171
|
+
- Doji: indicators/patterns/cdl_doji.md
|
|
172
|
+
- Hammer: indicators/patterns/cdl_hammer.md
|
|
173
|
+
- Engulfing: indicators/patterns/cdl_engulfing.md
|
|
174
|
+
- API Reference: api-reference.md
|
|
175
|
+
- Examples:
|
|
176
|
+
- Trend Analysis: examples/trend-analysis.md
|
|
177
|
+
- Momentum Trading: examples/momentum-trading.md
|
|
178
|
+
- Volatility Analysis: examples/volatility-analysis.md
|
|
179
|
+
- Contributing: contributing.md
|
data/ta-lib-license.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
Copyright (c) 1999-2025, Mario Fortier
|
|
2
|
+
|
|
3
|
+
Redistribution and use in source and binary forms, with or without
|
|
4
|
+
modification, are permitted provided that the following conditions are met:
|
|
5
|
+
|
|
6
|
+
1. Redistributions of source code must retain the above copyright notice, this
|
|
7
|
+
list of conditions and the following disclaimer.
|
|
8
|
+
|
|
9
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
10
|
+
this list of conditions and the following disclaimer in the documentation
|
|
11
|
+
and/or other materials provided with the distribution.
|
|
12
|
+
|
|
13
|
+
3. Neither the name of the copyright holder nor the names of its
|
|
14
|
+
contributors may be used to endorse or promote products derived from
|
|
15
|
+
this software without specific prior written permission.
|
|
16
|
+
|
|
17
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
18
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
19
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
20
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
21
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
22
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
23
|
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
24
|
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
25
|
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
26
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
metadata
ADDED
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: sqa-tai
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.1.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Dewayne VanHoozer
|
|
8
|
+
bindir: bin
|
|
9
|
+
cert_chain: []
|
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
11
|
+
dependencies:
|
|
12
|
+
- !ruby/object:Gem::Dependency
|
|
13
|
+
name: ta_lib_ffi
|
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
|
15
|
+
requirements:
|
|
16
|
+
- - "~>"
|
|
17
|
+
- !ruby/object:Gem::Version
|
|
18
|
+
version: '0.3'
|
|
19
|
+
type: :runtime
|
|
20
|
+
prerelease: false
|
|
21
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
22
|
+
requirements:
|
|
23
|
+
- - "~>"
|
|
24
|
+
- !ruby/object:Gem::Version
|
|
25
|
+
version: '0.3'
|
|
26
|
+
- !ruby/object:Gem::Dependency
|
|
27
|
+
name: bundler
|
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
|
29
|
+
requirements:
|
|
30
|
+
- - ">="
|
|
31
|
+
- !ruby/object:Gem::Version
|
|
32
|
+
version: '0'
|
|
33
|
+
type: :development
|
|
34
|
+
prerelease: false
|
|
35
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
36
|
+
requirements:
|
|
37
|
+
- - ">="
|
|
38
|
+
- !ruby/object:Gem::Version
|
|
39
|
+
version: '0'
|
|
40
|
+
- !ruby/object:Gem::Dependency
|
|
41
|
+
name: rake
|
|
42
|
+
requirement: !ruby/object:Gem::Requirement
|
|
43
|
+
requirements:
|
|
44
|
+
- - ">="
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: '0'
|
|
47
|
+
type: :development
|
|
48
|
+
prerelease: false
|
|
49
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
50
|
+
requirements:
|
|
51
|
+
- - ">="
|
|
52
|
+
- !ruby/object:Gem::Version
|
|
53
|
+
version: '0'
|
|
54
|
+
- !ruby/object:Gem::Dependency
|
|
55
|
+
name: minitest
|
|
56
|
+
requirement: !ruby/object:Gem::Requirement
|
|
57
|
+
requirements:
|
|
58
|
+
- - "~>"
|
|
59
|
+
- !ruby/object:Gem::Version
|
|
60
|
+
version: '5.0'
|
|
61
|
+
type: :development
|
|
62
|
+
prerelease: false
|
|
63
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
64
|
+
requirements:
|
|
65
|
+
- - "~>"
|
|
66
|
+
- !ruby/object:Gem::Version
|
|
67
|
+
version: '5.0'
|
|
68
|
+
- !ruby/object:Gem::Dependency
|
|
69
|
+
name: minitest-reporters
|
|
70
|
+
requirement: !ruby/object:Gem::Requirement
|
|
71
|
+
requirements:
|
|
72
|
+
- - ">="
|
|
73
|
+
- !ruby/object:Gem::Version
|
|
74
|
+
version: '0'
|
|
75
|
+
type: :development
|
|
76
|
+
prerelease: false
|
|
77
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
78
|
+
requirements:
|
|
79
|
+
- - ">="
|
|
80
|
+
- !ruby/object:Gem::Version
|
|
81
|
+
version: '0'
|
|
82
|
+
- !ruby/object:Gem::Dependency
|
|
83
|
+
name: simplecov
|
|
84
|
+
requirement: !ruby/object:Gem::Requirement
|
|
85
|
+
requirements:
|
|
86
|
+
- - ">="
|
|
87
|
+
- !ruby/object:Gem::Version
|
|
88
|
+
version: '0'
|
|
89
|
+
type: :development
|
|
90
|
+
prerelease: false
|
|
91
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
92
|
+
requirements:
|
|
93
|
+
- - ">="
|
|
94
|
+
- !ruby/object:Gem::Version
|
|
95
|
+
version: '0'
|
|
96
|
+
- !ruby/object:Gem::Dependency
|
|
97
|
+
name: debug_me
|
|
98
|
+
requirement: !ruby/object:Gem::Requirement
|
|
99
|
+
requirements:
|
|
100
|
+
- - ">="
|
|
101
|
+
- !ruby/object:Gem::Version
|
|
102
|
+
version: '0'
|
|
103
|
+
type: :development
|
|
104
|
+
prerelease: false
|
|
105
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
106
|
+
requirements:
|
|
107
|
+
- - ">="
|
|
108
|
+
- !ruby/object:Gem::Version
|
|
109
|
+
version: '0'
|
|
110
|
+
description: An SQA-specific wrapper around the ta_lib_ffi gem which access to TA-Lib
|
|
111
|
+
providing many technical analysis indicators for stock analysis. Part of the SQA
|
|
112
|
+
(Simple Qualitative Analysis) ecosystem.
|
|
113
|
+
email:
|
|
114
|
+
- dvanhoozer@gmail.com
|
|
115
|
+
executables: []
|
|
116
|
+
extensions: []
|
|
117
|
+
extra_rdoc_files: []
|
|
118
|
+
files:
|
|
119
|
+
- ".envrc"
|
|
120
|
+
- CHANGELOG.md
|
|
121
|
+
- COMMITS.md
|
|
122
|
+
- Gemfile
|
|
123
|
+
- Gemfile.lock
|
|
124
|
+
- LICENSE
|
|
125
|
+
- README.md
|
|
126
|
+
- Rakefile
|
|
127
|
+
- lib/extensions/ta_lib_ffi.rb
|
|
128
|
+
- lib/sqa/tai.rb
|
|
129
|
+
- lib/sqa/tai/version.rb
|
|
130
|
+
- mkdocs.yml
|
|
131
|
+
- ta-lib-license.md
|
|
132
|
+
homepage: https://github.com/MadBomber/sqa-tai
|
|
133
|
+
licenses:
|
|
134
|
+
- MIT
|
|
135
|
+
metadata:
|
|
136
|
+
allowed_push_host: https://rubygems.org
|
|
137
|
+
homepage_uri: https://github.com/MadBomber/sqa-tai
|
|
138
|
+
source_code_uri: https://github.com/MadBomber/sqa-tai
|
|
139
|
+
changelog_uri: https://github.com/MadBomber/sqa-tai/blob/main/CHANGELOG.md
|
|
140
|
+
documentation_uri: https://madbomber.github.io/sqa-tai
|
|
141
|
+
rdoc_options: []
|
|
142
|
+
require_paths:
|
|
143
|
+
- lib
|
|
144
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
145
|
+
requirements:
|
|
146
|
+
- - ">="
|
|
147
|
+
- !ruby/object:Gem::Version
|
|
148
|
+
version: 3.1.0
|
|
149
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
150
|
+
requirements:
|
|
151
|
+
- - ">="
|
|
152
|
+
- !ruby/object:Gem::Version
|
|
153
|
+
version: '0'
|
|
154
|
+
requirements: []
|
|
155
|
+
rubygems_version: 3.7.2
|
|
156
|
+
specification_version: 4
|
|
157
|
+
summary: SQA::TAI - Technical Analysis Indicators
|
|
158
|
+
test_files: []
|