Merge branch 'main' into bugfix/earnings-tz

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -55,15 +55,15 @@ body:
     id: debug-log
     attributes:
       label: "Debug log"
-      description: "Run code with debug logging enabled and post the full output. IMPORTANT INSTRUCTIONS: https://github.com/ranaroussi/yfinance/tree/main#logging"
+      description: "Run code with debug logging enabled - `yf.enable_debug_mode()` - and post the full output. Context: https://github.com/ranaroussi/yfinance/tree/main#logging"
     validations:
       required: true
 
   - type: textarea
     id: bad-data-proof
     attributes:
       label: "Bad data proof"
-      description: "If you think `yfinance` returning bad data, provide your proof here."
+      description: "If `yfinance` returning bad data, show proof here. Best is screenshot of finance.yahoo.com"
     validations:
       required: false
 

.github/workflows/deploy_doc.yml

@@ -0,0 +1,43 @@
+name: Build and Deploy Sphinx Docs
+
+on:
+  push:
+    branches:
+      - dev-documented
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check out the repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install Sphinx==8.0.2 pydata-sphinx-theme==0.15.4 Jinja2==3.1.4 sphinx-copybutton==0.5.2
+
+    - name: Build Sphinx documentation
+      run: |
+        sphinx-build -b html doc/source doc/_build/html -v
+
+    - name: List generated HTML files
+      run: |
+        ls -l -R doc/_build/html
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_branch: documentation
+        publish_dir: doc/_build/html
+        destination_dir: docs
+        enable_jekyll: false

.github/workflows/pyright.yml

@@ -0,0 +1,27 @@
+name: Pyright
+
+on:
+  pull_request:
+    branches:
+      - master
+      - main
+      - dev
+
+jobs:
+  pyright:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pyright
+
+    - name: Run Pyright
+      run: pyright . --level error

.github/workflows/python-publish.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python
       uses: actions/setup-python@v4
       with:

.gitignore

@@ -18,3 +18,10 @@ test.ipynb
 env/
 venv/
 ENV/
+
+# Documentation
+/doc/build/
+/doc/_build/
+/doc/source/reference/api
+!yfinance.css
+!/doc/source/development/assets/branches.png

CHANGELOG.rst

@@ -1,6 +1,66 @@
 Change Log
 ===========
 
+0.2.50
+------
+Fixes:
+- price repair #2111 #2139
+- download() appearance 2109
+- isin() error #2099
+- growth_estimates #2127
+Also new docs #2132
+
+0.2.49
+------
+Fix prices-clean rarely discarding good data #2122
+
+0.2.47 and 0.2.48
+-----------------
+Add yf.download(multi_level_index)
+
+0.2.46
+------
+Fix regression in 0.2.45 #2094
+
+0.2.45
+------
+Features:
+- Screener #2066 @ericpien
+Fixes
+- Tickers keyerror #2068 @antoniouaa
+- IndexError in some history() debug messages #2087
+- improve dividend repair #2090
+Maintenance
+- fix unit tests contextual imports #2067
+- fix typos #2072 @algonell
+- add Pyright type checking #2059 @marco-carvalho
+
+0.2.44
+------
+Features:
+- fetch funds #2041
+- fetch sector & industry #2058
+Fixes:
+- improve dividend repair #2062
+
+0.2.43
+------
+Fix price-repair bug introduced in 0.2.42 #2036
+
+0.2.42
+------
+Features:
+- fetch SEC filings #2009
+- fetch analysis #2023 @Fidasek009
+- price repair extended to dividends & adjust #2031
+Fixes:
+- fix error on empty options chain #1995 @stevenbischoff
+- use dict.get() to safely access key in Holders #2013 @ericpien
+- fix datetime conversion with mixed timezones when ignore_tz is False #2016 @mreiche
+- handle faulty response object when getting news. #2021 @ericpien
+Maintenance:
+- prices: improve exceptions and logging #2000
+
 0.2.41
 ------
 Improvements:
@@ -333,7 +393,7 @@ Jumping to 0.2 for this big update. 0.1.* will continue to receive bug-fixes
 - Fix timezone handling
 - Fix handling of missing data
 - Clean&format earnings_dates table
-- Add ``.get_earnings_dates()`` to retreive earnings calendar
+- Add ``.get_earnings_dates()`` to retrieve earnings calendar
 - Added ``.get_earnings_history()`` to fetch earnings data
 
 0.1.70
@@ -645,7 +705,7 @@ Jumping to 0.2 for this big update. 0.1.* will continue to receive bug-fixes
 - Removed 5 second wait for every failed fetch
 - Reduced TTL for Yahoo!'s cookie
 - Keeps track of failed downloads and tries to re-download all failed downloads one more time before giving up
-- Added progress bar (can be turned off useing ``progress=False``)
+- Added progress bar (can be turned off using ``progress=False``)
 
 0.0.7
 -------