sqa 0.0.21 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90a60fb96ea11073c750a7e0b36d8a2d8283bbfeff8322907617794b7111502e
-  data.tar.gz: dbfa9486131b8b39016b46b9ef6188bdfefc279d8a5adc7a79b6c23f1ad1779b
+  metadata.gz: d905658af9c43b28516a66c068064fb83391b278885fbc6804a934be463cf316
+  data.tar.gz: c8b8699dc6209b3370d72a34a43a29de70f6cf4f7e543766b676be6a249e879c
 SHA512:
-  metadata.gz: 975de4af9b0c063a66b8a2292b99c18859d30d49ab6b7fab82416916a1cbf3685b4c9e5f56ea5e1cbe635ac5e9fb67aacf2432ec95ef74f541da9a0edf1e6c61
-  data.tar.gz: cf25850a673a96bf60fe40cac0ca488a670c8ba8eb489e7c4502beb3b53bc60d1c716a22c4f5c78ceffd66e6ac92323e13b8278988fa3ffd0e4d26554249b908
+  metadata.gz: 8351015c1c4b75c8b75d2460820d4d162ad51b9e29d60c0989ecd413485670f6c4d55a65a2f52667bcf1c24bda04df3c6fc8bad196a92b2f8c3319c005e977c0
+  data.tar.gz: 120bef4ce4c29cbf5ab412bb918f710f0875243cefef5bb085bcea8c29080b5754a42a313eb24b5b33aa4d5a3667e2147ceb97567941f528712a7ee42c56b32d

data/.config/tocer/configuration.yml

@@ -1,4 +1,5 @@
 label: "## Table of Contents"
 patterns:
+  - "README.md"
   - "docs/terms_of_use.md"
 root_dir: "."

data/README.md

@@ -4,6 +4,33 @@ This is a very simplistic set of tools for running technical analysis (quantitat
 
 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.
 
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+## Table of Contents
+
+  - [This is a Work in Progress](#this-is-a-work-in-progress)
+  - [Installation](#installation)
+  - [Semantic Versioning](#semantic-versioning)
+  - [Usage](#usage)
+    - [Setup a Config File](#setup-a-config-file)
+    - [AlphaVantage](#alphavantage)
+    - [TradingView](#tradingview)
+    - [Yahoo Finance](#yahoo-finance)
+  - [Playing in IRB](#playing-in-irb)
+    - [With Stocks and Indicators](#with-stocks-and-indicators)
+      - [Get Historical Prices](#get-historical-prices)
+    - [Playing in the IRB - Setup](#playing-in-the-irb---setup)
+    - [Playing in the IRB - Statistics](#playing-in-the-irb---statistics)
+    - [Playing in the IRB - Indicators](#playing-in-the-irb---indicators)
+    - [Playing in the IRB - Strategies](#playing-in-the-irb---strategies)
+  - [Included Program Examples](#included-program-examples)
+    - [Analysis](#analysis)
+    - [Web](#web)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
 ## This is a Work in Progress
 
 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](https://github.com/intridea/hashie) library.
@@ -19,7 +46,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     gem install sqa
 
-### Semantic Versioning
+## Semantic Versioning
 
 `sqa` uses the [sem_version](https://github.com/canton7/sem_version) gem to provide a semantic version object.  Sure its old; but, so am I.  Doesn't mean we can't do the job.
 
@@ -31,6 +58,10 @@ sqa --version
 
 SQA.version # returns SemVersion object
 exit(1) unless SQA.version >= SemVersion("1.0.0")
+
+# Okay, you're right, you could put that kind of version
+# constraint in a Gemfile and let bundler handle the
+# dependencies for you.
 ```
 
 ## Usage
@@ -72,6 +103,9 @@ Examples:
 
 WARNING: This is a toy, a play thing, not intended for serious use.
 ```
+
+More about the two included programs `analysis` and `web` later.
+
 ### 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:
@@ -96,7 +130,7 @@ You can also have one data directory and multiple portfolio and trades files wit
 
 Put your API key in the system environment variable `AV_API_KEY`
 
-TODO why is it not part of the configuration?  ought to be.
+<!-- TODO: why is it not part of the configuration?  ought to be. -->
 
 
 ### TradingView
@@ -105,10 +139,23 @@ TODO why is it not part of the configuration?  ought to be.
 
 Put your API key in the system environment variable `TV_API_KEY`
 
-TODO why is it not part of the configuration?  ought to be.
+<!-- TODO: why is it not part of the configuration?  ought to be. -->
 
 I kinda like their Terms of Use.  I've started crafting an [SQA Terms of Use](docs/terms_of_use.md) document based on theirs.  I specifically like sections 7 and 8.
 
+### Yahoo Finance
+
+The finance.yahoo.com website no longer supports an API.  To get information from this website you must scrape it.  That is how historical / receint stock prices are being obtained in the DataFrame::YahooFinance class.  I do not like doing this and do not necessarily recommend using YahooFinance as a source for stock price data.
+
+In the SQA::Stock class the default source is AlphaVantage which has its own limitations.
+
+This is not to say that finance.yahoo.com has no use.  In fact is is the perfect place to go to manually download CSV files of historical stock price data.  When you do that through your browser, the CSV file will be placed in your default downloads directory.
+
+To use this downed file within the SQA environment it must be moved into your `SQA.`data_dir` with a filename that is all lowercase.  The filename must be the stock's symbol with a `.csv` extension.  For example if you downloaded the entire historical stock price data for Apple Computer (AAPL) the filename in the SQA.data_dir should be "aapl.csv"
+
+You can manually go to the Yahoo Finance website at [https://finance.yahoo.com/quote/AAPL/history?p=AAPL](https://finance.yahoo.com/quote/AAPL/history?p=AAPL)
+
+
 ## Playing in IRB
 
 You can play around in IRB with the SQA framework.
@@ -124,7 +171,9 @@ Historical price data is kept in the `SQA.data_dir` in a CSV file whose name is
 
 Go to [https::/finance.yahoo.com](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
+You may need to create a `portfolio.csv` file or you may not.
+
+<!-- TODO: Add a section on how to create a portfolio fCSV file -->
 
 The CSV files will be named by the stock's ticker symbol as lower case.  For example: `aapl.csv`
 
@@ -275,6 +324,24 @@ Any specific strategy may not work on every stock. Using the historical data, it
 
 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.
 
+## Included Program Examples
+
+<!-- TODO: What is the name of these things?  From the help text they are called commands.  They are treated in the code base as a class under the SQA module.  Its easy to change the CLI help text to call these programs rather than commands. -->
+
+There are at least two included programs that make use of the `SQA` library.
+
+<!-- TODO: These kinds of things need to be in their own repository. -->
+
+<!-- TODO: Need to complete the API for invoking one of these "programs" from the sqa cli. -->
+
+### Analysis
+
+Does an analysis of a portfollio of stocks.
+
+### Web
+
+Provides a browser-based interface to some stuff.
+
 ## Contributing
 
 I can always use some help on this stuff.  Got an idea for a new indicator or strategy?  Want to improve the math?  Make the signals better?  Let's collaborate!

data/checksums/sqa-0.0.21.gem.sha512

@@ -1 +1 @@
-bd37c208c9c593043ac51fd79e3cf45eac2d432109b13773af13a534b833bbe5277002f03567d2659bc70150593f084db025d8cd08bed3f803db4db7809e7128
+5e682462398140077e381829872acc847ce0f2a391af4ab7d66c94f8bebf05dc29a760fcdfecfe07886ad23440496973e6f6cdd7012d6db577b923281e1f67b7

data/checksums/sqa-0.0.22.gem.sha512

@@ -0,0 +1 @@
+053cf9a393976ae5292918cd7386b9c2e0567788f43525b77ca06ee574a98b39c3d81d43d65358d2d8cf896060e576897484945c119f1f2d57480d9407c0555a

data/lib/sqa/data_frame/yahoo_finance.rb

@@ -1,6 +1,12 @@
 # lib/sqa/data_frame/yahoo_finance.rb
 # frozen_string_literal: true
 
+=begin
+  The website financial.yahoo.com no longer supports an API.
+  To get recent stock historical price updates you have
+  to scrape the webpage.
+=end
+
 
 class SQA::DataFrame
   class YahooFinance

data/lib/sqa/data_frame.rb

@@ -26,30 +26,39 @@ class SQA::DataFrame
   # mapping is a Hash { old_key => new_key }
   # transformers is also a Hash { key => Proc}
   def initialize(
-      aofh_or_hofa= {}, # Array of Hashes or hash of array or hash
+      raw_data=     {}, # Array of Hashes or hash of array or hash
       mapping:      {}, # { old_key => new_key }
       transformers: {}  # { key => Proc }
     )
 
-    if aofh_or_hofa.is_a? Hash
-      initialize_hofa(aofh_or_hofa, mapping: mapping)
+    if raw_data.is_a? Hash
+      initialize_hofa(raw_data, mapping: mapping)
 
-    elsif aofh_or_hofa.is_a?(Array)     &&
-          aofh_or_hofa.first.is_a?(Hash)
-      initialize_aofh(aofh_or_hofa, mapping: mapping)
+    elsif raw_data.is_a?(Array)     &&
+          raw_data.first.is_a?(Hash)
+      initialize_aofh(raw_data, mapping: mapping)
 
     else
       raise BadParameterError, "Expecting Hash or Array of Hashes got: #{aofh_or_hofa.class}"
     end
 
-    coerce_vectors!(transformers) unless transformers.empty?
+    coerce_vectors!(transformers) if good_data? && !(transformers.nil? || transformers.empty?)
+  end
+
+
+  def good_data?
+    return false if @data.empty? || @data.values.all?{|v| v.nil? || v.empty?}
+
+    true
   end
 
 
   def initialize_aofh(aofh, mapping:)
-    hofa  = self.class.aofh_to_hofa(
+    klass = self.class
+
+    hofa  = klass.aofh_to_hofa(
                   aofh,
-                  mapping:      mapping
+                  mapping:  mapping
                 )
 
     initialize_hofa(hofa, mapping: mapping)
@@ -57,7 +66,8 @@ class SQA::DataFrame
 
 
   def initialize_hofa(hofa, mapping:)
-    hofa  = self.class.normalize_keys(
+    klass = self.class
+    hofa  = klass.normalize_keys(
               hofa,
               adapter_mapping: mapping
             ) unless mapping.empty?
@@ -283,7 +293,7 @@ class SQA::DataFrame
         end
       end
 
-      # SMELL: This might be necessary
+      # SMELL: This might not be necessary
       normalize_keys(hofa, adapter_mapping: mapping)
     end
 
@@ -291,13 +301,14 @@ class SQA::DataFrame
     def normalize_keys(hofa, adapter_mapping: {})
       hofa    = rename(adapter_mapping, hofa)
       mapping = generate_mapping(hofa.keys)
+
       rename(mapping, hofa)
     end
 
 
     def rename(mapping, hofa)
       mapping.each_pair do |old_key, new_key|
-        hofa[new_key] = hofa.delete(old_key)
+        hofa[new_key] = hofa.delete(old_key) if hofa.has_key?(old_key)
       end
 
       hofa

data/lib/sqa/stock.rb

@@ -101,7 +101,7 @@ class SQA::Stock
     return if df2.nil?  # CSV file is up to date.
 
     df_nrows  = @df.nrows
-    @df.append(df2)
+    @df.append!(df2)
 
     if @df.nrows > df_nrows
       @df.to_csv(@df_path)

data/lib/sqa/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqa
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-24 00:00:00.000000000 Z
+date: 2023-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alphavantage
@@ -248,6 +248,7 @@ files:
 - checksums/sqa-0.0.2.gem.sha512
 - checksums/sqa-0.0.20.gem.sha512
 - checksums/sqa-0.0.21.gem.sha512
+- checksums/sqa-0.0.22.gem.sha512
 - checksums/sqa-0.0.3.gem.sha512
 - checksums/sqa-0.0.4.gem.sha512
 - checksums/sqa-0.0.5.gem.sha512