sqa 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 911775606b7e0fa046261c5a9bc4d3be21ca9caf38c37011141f1393ac6e5063
-  data.tar.gz: d70ae996a39dbe7c386750286cb4cc437681d584945b31104e91b06c30b1600f
+  metadata.gz: b7733f5cb84c4ccbad5e68105e818b35f1aca450fd97eeb3186cfb9a1962d44e
+  data.tar.gz: a9b2bf2a0fa6a91de1367fd73beac6a28d263024ded37c216520120cc3181cc9
 SHA512:
-  metadata.gz: '0074688f69947d20d5aae7c81b090a91fb4f06862084b2349b248ecdf2e17376f47d5a1acffbfb7b2700865cf25f5ff5ba054514d00ed88750f46224b4c9360e'
-  data.tar.gz: 38d1ebf511e9dfa2b87084ed77093e2fc03ccf6eeb6a00e42d1060acca82e135d0b4c0d36a25d9f9bc4a2dd9adf91749a6640aab14b304e33f24fee0c3eb7e15
+  metadata.gz: 27280c675c37a92f450d5108c40848cc65a3975e8e783ca25cbbee0bfa18b1c570d697c4c33d4fd73d84c57d717df3e6cbb8667c51fb3ed8fe48df509f9d1f7e
+  data.tar.gz: 475333a102814f5bef21dbea61126bf6b0b61836cccb6a333acc2dbcaa2ba5bc14c8c9191b31065777ca984fcec883fb37da36b07a9121f2afeb0a0004bc841b

data/README.md

@@ -1,22 +1,13 @@
-**Replacing Daru** with Hashie::Mash
-
-This is branch hashie_df
-
 # SQA - Simple Qualitative Analysis
 
-This is a very simplistic set of tools for running technical analysis on a stock portfolio.  Simplistic means it is not reliable nor intended for any kind of financial use.  Think of it as a training tool.  I do.  Its helping me understand why I need professional help from people who know what they are doing.
+This is a very simplistic set of tools for running technical analysis (quantitative and qualitative) on a stock portfolio.  Simplistic means it is not reliable nor intended for any kind of mission-critical financial use.  Think of it as a training tool.  I do.  Its helping me understand why I need professional help from people who know what they are doing.
 
-The BUY/SELL signals that it generates are part of a game.  **DO NOT USE** when real money is at stake.
+The BUY/SELL signals that it generates should not be taken seriously.  **DO NOT USE** this library when real money is at stake.  If you lose your shirt playing in the stock market don't come crying to me.  I think playing in the market is like playing in the street.  You are going to get run over.
 
 ## This is a Work in Progress
 
-I'm making use of lots of gems which may not be part of the gemspec at this time.  I will be adding them as they make the final cut as to fitness for the intended function.  Some gems are configurable.  For example the default for the plotting library is `gruff`.  There are several available that the `daru` gem can use.
-
-### DARU or RedAmber
+I am experimenting with different gems to support various functionality.  Sometimes they do not work out well.  For example I've gone through two different gems to implement the data frame capability.  Neither did what I wanted so I ended up creating my own data frame class based upon the old tried and true Hashie library.
 
-I'm just really using `daru` for its data frame object;  However, I just learned about the RedAmber data frame object in Ruby based off of Apache Arrow.  I'm going to look at that product since it is actively maintained.
-
-https://github.com/red-data-tools/red_amber
 
 ## Installation
 
@@ -28,62 +19,200 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     gem install sqa
 
-## ShoutOut To `daru`
+### Semantic Versioning
+
+```ruby
+SQA.version # returns SemVersion object
+exit(1) unless SQA.version >= SemVersion("1.0.0")
+```
+
+## Usage
+
+**Do not use!** but its okay to play with.
 
-**D**ata **A**nalysis in **RU**by
+`SQA` can be used from the command line or as a library in your own application.
 
-http://github.com/v0dro/daru
+`SQA` has a command line component.
 
-Its `DataFrame` class is a very interesting in memory data structure.
+```plaintext
+$ sqa --help
+Stock Quantitative Analysis (SQA)
 
-## Usage
+Usage: sqa [analysis|web] [OPTIONS]
+
+A collection of things
+
+Options:
+  -c, --config string             Path to the config file
+      --data-dir string           Set the directory for the SQA data
+  -d, --debug                     Turn on debugging output
+      --dump-config path_to_file  Dump the current configuration
+  -h, --help                      Print usage
+  -l, --log_level string          Set the log level (debug, info, warn, error,
+                                  fatal)
+  -p, --portfolio string          Set the filename of the portfolio
+  -t, --trades string             Set the filename into which trades are
+                                  stored
+  -v, --verbose                   Print verbosely
+      --version                   Print version
+
+Examples:
+  sqa -c ~/.sqa.yml -p portfolio.csv -t trades.csv --data-dir ~/sqa_data
+
+  Optional Command Available:
+    analysis - Provide an Analysis of a Portfolio
+    web - Run a web server
+
+WARNING: This is a toy, a play thing, not intended for serious use.
+```
+### Setup a Config File
+
+You will need to create a directory to store the `sqa` data and a configuration file.  You can start by doing this:
+
+```ruby
+gem install sqa
+mkdir ~/Documents/sqa_data
+sqa --data-dir ~/Documents/sqa_data --dump-config ~/.sqa.yml
+```
+
+By default `SQA` looks for a configuration file named `.sqa.yml` in the current directory.  If it does not find one there it looks in the home directory.  You can use the `--config` CLI option to specify a path to your custom config file name.
+
+
+### AlphaVantage
+
+`SQA` makes use of the `AlphaVantage` API to get some stock related information.  You will need an API key in order to use this functionality.  They have a free rate limited API key which allows 5 accesses per second; total of 100 accesses in a day.  If you are doing more than that you are not playing an ought to purchase one of there serious API key plans.
+
+[https://www.alphavantage.co/](https://www.alphavantage.co/)
 
-**Do not use!**
 
 ## Playing in IRB
 
-You can play around in IRB with the SQA framework in two different areas.  First is the stocks and indicators.  The second is with trading strategies.
+You can play around in IRB with the SQA framework.
+
 
 ### With Stocks and Indicators
 
-You will need some CSV files.
+You will need some CSV files.  If you ask for a stock to which you have not existing historical price data in a CSV file, `SQA` can use either Alpha Vantage or Yahoo Finance to get some data.  I like Alpha Vantage better because it has a well defined and documented API.  Yahoo Finance on the other hand does not.  You can manually download historical stock price data from Yahoo Finance into you `sqa data directory`
+
+Historical price data is kept in the `SQA.data_dir` in a CSV file whose name is all lowercase.  If you download the CSV file for the stock symbol "AAPL" it should be saved in you `SQA.data_dir` as `aapl.csv`
 
 #### Get Historical Prices
 
-Go to https::/finance.yahoo.com and down some historical price data for your favorite stocks.  Put those CSV files in to the `sqa_data` directory in your HOME directory.
+Go to https::/finance.yahoo.com and down some historical price data for your favorite stocks.  Put those CSV files into the `SQA.data_dir`.
 
 You may need to create a `portfolio.csv` file or you may not.  TODO
 
-The CSV files will be named by the stock's ticker symbol.  For example: AAPL.csv
+The CSV files will be named by the stock's ticker symbol.  For example: `aapl.csv`
+
+### Playing in the IRB - Setup
 
 ```ruby
 require 'sqa'
-# TODO: See the documentation on configurable items
-# Omit to use defaults
-SQA::Config.from_file(path_to_config_file)
+require 'sqa/cli'
+
+# You can pass a set of CLI options in a String
+SQA.init "-c ~/.sqa.yml"
 
-# initialize framework from configuration values
-SQA.init
+aapl = SQA::Stock.new(ticker: 'aapl', source: :alpha_vantage)
+#=> aapl with 1207 data points from 2019-01-02 to 2023-10-17
+```
+
+`aapl.df`   is the data frame.  It is implemented as a Hashie::Mash obect -- a Hash or Arrays.
+
+```ruby
+aapl.df.keys
+#=> [:timestamp, :open_price, :high_price, :low_price, :close_price, :adj_close_price, :volume]
 
-aapl = SQA::Stock.new('aapl')
+aapl.df.adj_close_price.last(5)
+#=> [179.8, 180.71, 178.85, 178.72, 177.15]
 ```
 
-`aapl.df` is the Daru::DataFrame
-see the `daru` gem for how to manipulate the DataFrame
+`aapl.data` is basic static data, company name, industry etc.  It is also implemented as a Hassie::Mash object but is primary treated as a plain hash object.
+
+```ruby
+aapl.data.keys
+#=> [:ticker, :source, :indicators, :overview]
+
+aapl.data.source
+=> "alpha_vantage"
+
+aapl.data.overciew.keys
+=> [:symbol, :asset_type, :name, :description, :cik, :exchange, :currency, :country, :sector, :industry, :address, :fiscal_year_end, :latest_quarter, :market_capitalization, :ebitda, :pe_ratio, :peg_ratio, :book_value, :dividend_per_share, :dividend_yield, :eps, :revenue_per_share_ttm, :profit_margin, :operating_margin_ttm, :return_on_assets_ttm, :return_on_equity_ttm, :revenue_ttm, :gross_profit_ttm, :diluted_epsttm, :quarterly_earnings_growth_yoy, :quarterly_revenue_growth_yoy, :analyst_target_price, :trailing_pe, :forward_pe, :price_to_sales_ratio_ttm, :price_to_book_ratio, :ev_to_revenue, :ev_to_ebitda, :beta, :"52_week_high", :"52_week_low", :"50_day_moving_average", :"200_day_moving_average", :shares_outstanding, :dividend_date, :ex_dividend_date]
+
+```
+
+### Playing in the IRB - Statistics
+
+Basic statistics are available on all of the SQA::DataFrame arrays.
+
+```ruby
+require 'amazing_print' # to get the ap command
+
+# Look at some summary stats on the last 5 days of
+# adjusted closing pricess of AAPL
+ap aapl.df.adj_close_price.last(5).summary
+{
+                        :frequencies => {
+         179.8 => 1,
+        180.71 => 1,
+        178.85 => 1,
+        178.72 => 1,
+        177.15 => 1
+    },
+                                :max => 180.71,
+                               :mean => 179.046,
+                             :median => 178.85,
+                           :midrange => 178.93,
+                                :min => 177.15,
+                               :mode => nil,
+                        :proportions => {
+         179.8 => 0.2,
+        180.71 => 0.2,
+        178.85 => 0.2,
+        178.72 => 0.2,
+        177.15 => 0.2
+    },
+                          :quartile1 => 178.85,
+                          :quartile2 => 179.8,
+                          :quartile3 => 180.71,
+                              :range => 3.5600000000000023,
+                               :size => 5,
+                                :sum => 895.23,
+    :sample_coefficient_of_variation => 0.006644656242680533,
+                    :sample_kurtosis => 2.089087404921432,
+                        :sample_size => 5,
+                    :sample_skewness => -0.2163861377512453,
+          :sample_standard_deviation => 1.1896991216269788,
+              :sample_standard_error => 0.532049621745943,
+                    :sample_variance => 1.415384000000005,
+                     :sample_zscores => {
+         179.8 => 0.6337736880639895,
+        180.71 => 1.3986729667618856,
+        178.85 => -0.16474753695031497,
+        178.72 => -0.2740188624785824,
+        177.15 => -1.5936802553969298
+    }
+}
+#=> nil
+```
+
+### Playing in the IRB - Indicators
+
 The SQA::Indicator class methods use Arrays not the DataFrame
 Here is an example:
 
 
 ```ruby
-prices = aapl.df.adj_close_price.to_a
+prices = aapl.df.adj_close_price
 period = 14 # size of the window in prices to analyze
 
 rsi = SQA::Indicator.rsi(prices, period)
+#=> {:rsi=>63.46652828230407, :trend=>:normal}
 ```
 
-### With Strategies
+### Playing in the IRB - Strategies
 
-The strategies work off of an Object that contains the information required to make its recommendation.  Build on the previous Ruby snippet ...
+The strategies work off of an Object that contains the information required to make its recommendation.  Building on the previous Ruby snippet ...
 
 ```ruby
 require 'ostruct'
@@ -100,19 +229,24 @@ ss.add SQA::Strategy::RSI
 
 # This is an Array with each "trade" method
 # that is defined in each strategy added
-ss.strategies
+ap ss.strategies
+[
+    [0] SQA::Strategy::Random#trade(vector),
+    [1] SQA::Strategy::RSI#trade(vector)
+]
 
 # Execute those strategies
 results = ss.execute(vector)
+#=> [:hold, :hold]
 ```
 
 `results` is an Array with an entry for each strategy executed.  The entries are either :buy, :sell or :hold.
 
 Currently the strategies are executed sequentially so the results can easily be mapped back to which strategy produced which result.  In the future that will change so that the strategies are executed concurrently.  When that change is introduced the entries in the `results` object will change -- most likely to an Array of Hashes.
 
-### See my **experiments** Repository in the **stocks** Directory
+Any specific strategy may not work on every stock. Using the historical data, it is possible to see which strategy works better for a specific stock.  **Of course the statistical motto is that historical performance is not a fail-proof indicator for future performance.**
 
-I have a program `analysis.rb` that I'm writing along with this `sqa` gem.  Its intended as a practical example/test case for how the gem can be used to analyze a complete portfolio one stock at a time.
+The strategies that come with the `SQA::Strategy` class are examples only.  Its expected that you will come up with your own.  If you do, consider sharing them.
 
 ## Contributing
 

data/checksums/sqa-0.0.18.gem.sha512

@@ -0,0 +1 @@
+0b3d327017ae67b0ce46082acff8bebdb4a981575e9818418c7279de286a233dde003877f3907b37f3f7e0de236015b4ee4404818d692509c805641862025bc6

data/lib/sqa/stock.rb

@@ -104,7 +104,7 @@ class SQA::Stock
     @df.append(df2)
 
     if @df.nrows > df_nrows
-      @df.to_csv(file_path)
+      @df.to_csv(@df_path)
     end
   end
 

data/lib/sqa/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SQA
-  VERSION = "0.0.17"
+  VERSION = "0.0.18"
 
   class << self
     def version

data/lib/sqa.rb

@@ -20,9 +20,10 @@ require 'active_support/core_ext/string'
 require 'alphavantage' 	# TODO: add rate limiter to it; ** PR submitted! **
 require 'api_key_manager'
 require 'amazing_print'
-require 'descriptive_statistics'
 require 'faraday'
 require 'hashie'
+require 'lite/statistics'
+require 'lite/statistics/monkey_patches' # patch to Enumerable
 require 'nenv'
 require 'sem_version'
 require 'sem_version/core_ext'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqa
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-09 00:00:00.000000000 Z
+date: 2023-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: descriptive_statistics
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,33 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: lite-statistics
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nenv
   requirement: !ruby/object:Gem::Requirement
@@ -242,6 +242,7 @@ files:
 - checksums/sqa-0.0.13.gem.sha512
 - checksums/sqa-0.0.15.gem.sha512
 - checksums/sqa-0.0.17.gem.sha512
+- checksums/sqa-0.0.18.gem.sha512
 - checksums/sqa-0.0.2.gem.sha512
 - checksums/sqa-0.0.3.gem.sha512
 - checksums/sqa-0.0.4.gem.sha512
@@ -349,7 +350,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: sqa - Stock Qualitative Analysis