yfinance_wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d85bd7392805b47e38c34a148124b7ecd68822b597001c9051aeacd30791516
+  data.tar.gz: 12e22cf4668680cd6a6a3d10934575a77987459483cbd7aecc5a136a7b963aac
+SHA512:
+  metadata.gz: be045351689c7bd513a98ec75817812946f447bdb1956ec8a88703c33c12219a86870739b803cb9f10593dd54f3a6b443e5f1f4005d717c3e1f1905644109b3f
+  data.tar.gz: 6595f89d4e915571c134734b32206b7fcbb6aab8bcdd8f946762743647692a22ddc2973c0ee9e489f41edb645132082523fcb296291291fb42eb4feae3d278e7

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false

data/README.md

@@ -0,0 +1,26 @@
+# YfinanceWrapper
+
+YfinanceWrapper is a Ruby wrapper library for the Python yfinance library, which provides access to Yahoo Finance's API.
+
+This library has the following features:
+
+- Uses PyCall to make the Python yfinance library accessible from Ruby
+- Simple and intuitive API
+- Compatible with Ruby 3.0 and above
+
+Main features:
+
+- Stock information retrieval
+- Stock price data retrieval
+- Company information retrieval
+
+This library supports the development of financial data applications and analysis tools by providing easy access to Yahoo Finance's data through Ruby.
+
+# Installation
+
+1. Install python3.
+2. Install yfinance
+
+```bash
+pip3 install yfinance
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/yfinance_wrapper/ticker.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "pycall/import"
+
+module YfinanceWrapper
+  class Ticker
+    def initialize(symbol)
+      @ticker = YfinanceWrapper.yf.Ticker.new(symbol)
+    end
+
+    def info
+      @ticker.info.to_h
+    end
+
+    def history(*args, **kwargs)
+      result = @ticker.history(*args, **kwargs)
+      indexes = result.index
+
+      res = {}
+
+      indexes.size.times do |i|
+        key = indexes[i]
+        res[Time.new(key.to_s)] = candle_to_hash(result.loc[key], %w[Open High Low Close])
+      end
+
+      res
+    end
+
+    private
+
+    # Add Candle class when candle needs more mothods.
+    def candle_to_hash(candle, keys)
+      keys.each_with_object({}) do |key, hash|
+        hash[key] = candle[key].to_f
+      end
+    end
+  end
+end

data/lib/yfinance_wrapper/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module YfinanceWrapper
+  VERSION = "0.1.0"
+end

data/lib/yfinance_wrapper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "yfinance_wrapper/ticker"
+include PyCall::Import
+module YfinanceWrapper
+  pyimport :yfinance, as: :yf
+  # rubocop:disable Style/ClassVars
+  @@yf = yf
+  # rubocop:enable Style/ClassVars
+end

data/sig/yfinance_wrapper.rbs

@@ -0,0 +1,4 @@
+module YfinanceWrapper
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: yfinance_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ys7i
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pycall
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: numpy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: pandas
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A simple and easy-to-use Ruby wrapper library for Yahoo Finance API
+email:
+- s7i.yuhi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- lib/yfinance_wrapper.rb
+- lib/yfinance_wrapper/ticker.rb
+- lib/yfinance_wrapper/version.rb
+- sig/yfinance_wrapper.rbs
+homepage: https://github.com/ys7i/yfinance_wrapper
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ys7i/yfinance_wrapper
+  source_code_uri: https://github.com/ys7i/yfinance_wrapper
+  changelog_uri: https://github.com/ys7i/yfinance_wrapper/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: A Ruby wrapper for Yahoo Finance API
+test_files: []