Merge pull request #2489 from ranaroussi/dev

sync dev -> main

Author: ValueRaider

.github/workflows/deploy_doc.yml

@@ -3,7 +3,8 @@ name: Build and Deploy Sphinx Docs
 on:
   push:
     branches:
-      - dev-documented
+      - main
+      # - dev-documented
   workflow_dispatch:
 
 jobs:

.github/workflows/ruff.yml

@@ -11,3 +11,5 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: chartboost/ruff-action@v1
+        with:
+          args: check . --exclude yfinance/pricing_pb2.py

README.md

@@ -53,6 +53,8 @@ Install `yfinance` from PYPI using `pip`:
 $ pip install yfinance
 ```
 
+### [yfinance relies on the community to investigate bugs and contribute code. Here's how you can help.](CONTRIBUTING.md)
+
 ---
 
 ![Star History Chart](https://api.star-history.com/svg?repos=ranaroussi/yfinance)

doc/source/advanced/caching.rst

@@ -1,47 +1,6 @@
 Caching
 =======
 
-Smarter Scraping
-----------------
-
-Install the `nospam` package to cache API calls and reduce spam to Yahoo:
-
-.. code-block:: bash
-
-   pip install yfinance[nospam]
-
-To use a custom `requests` session, pass a `session=` argument to
-the Ticker constructor. This allows for caching calls to the API as well as a custom way to modify requests via  the `User-agent` header.
-
-.. code-block:: python
-
-   import requests_cache
-   session = requests_cache.CachedSession('yfinance.cache')
-   session.headers['User-agent'] = 'my-program/1.0'
-   ticker = yf.Ticker('MSFT', session=session)
-   
-   # The scraped response will be stored in the cache
-   ticker.actions
-
-
-Combine `requests_cache` with rate-limiting to avoid triggering Yahoo's rate-limiter/blocker that can corrupt data.
-
-.. code-block:: python
-
-   from requests import Session
-   from requests_cache import CacheMixin, SQLiteCache
-   from requests_ratelimiter import LimiterMixin, MemoryQueueBucket
-   from pyrate_limiter import Duration, RequestRate, Limiter
-   class CachedLimiterSession(CacheMixin, LimiterMixin, Session):
-      pass
-
-   session = CachedLimiterSession(
-      limiter=Limiter(RequestRate(2, Duration.SECOND*5)),  # max 2 requests per 5 seconds
-      bucket_class=MemoryQueueBucket,
-      backend=SQLiteCache("yfinance.cache"),
-   )
-
-
 Persistent Cache
 ----------------
 

doc/source/development/branches.rst

@@ -1,5 +1,6 @@
+********
 Branches
----------
+********
 
 To support rapid development without breaking stable versions, this project uses a two-layer branch model:
 

doc/source/development/code.rst

@@ -0,0 +1,64 @@
+****
+Code
+****
+
+1. Fork the repository on GitHub. If already forked, remember to `Sync fork`
+2. Clone your forked repository:
+
+   .. code-block:: bash
+
+      git clone https://github.com/{user}/{repo}.git
+
+3. Create a new branch for your feature or bug fix, from appropriate base branch:
+
+   .. code-block:: bash
+
+      git checkout {base e.g. dev}
+      git pull
+      git checkout -b {branch}
+
+4. Make your changes, commit them, and push your branch to GitHub. To keep the commit history and `network graph <https://github.com/ranaroussi/yfinance/network>`_ compact:
+
+   - for long commit messages use this format. Your long message can be multiple lines (tip: copy-paste):
+
+     .. code-block:: bash
+
+        git commit -m "short sentence summary" -m "full commit message"
+
+   - **git squash** tiny or negligible commits with meaningful ones, or to combine successive related commits. `git squash guide <https://docs.gitlab.com/ee/topics/git/git_rebase.html#interactive-rebase>`_
+
+     .. code-block:: bash
+
+        git rebase -i HEAD~2
+        git push --force-with-lease origin {branch}
+
+5. If your branch is old and missing important updates in base branch, then instead of merging in, do a git rebase. This keeps your branch history clean. E.g.
+
+   .. code-block:: bash
+     
+      git checkout {base e.g. dev}
+      git pull
+      git checkout {branch}
+      git rebase {base}
+      git push --force-with-lease origin {branch}
+
+6. `Open a pull request on Github <https://github.com/ranaroussi/yfinance/pulls>`_.
+
+More Git stuff
+---------
+
+- ``git rebase``. You might be asked to move your branch from ``main`` to ``dev``. Important to update **all** relevant branches.
+
+  .. code-block:: bash
+
+     # update all branches:
+     git checkout main
+     git pull
+     git checkout dev
+     git pull
+     # rebase:
+     git checkout {branch}
+     git pull
+     git rebase --onto dev main {branch}
+     git push --force-with-lease origin {branch}
+

doc/source/development/contributing.rst

@@ -1,6 +1,6 @@
-*************************************
-Contribution to the documentation
-*************************************
+*************
+Documentation
+*************
 
 .. contents:: Documentation:
    :local:
@@ -36,15 +36,18 @@ To build the documentation locally, follow these steps:
 
 3. **View Documentation Locally**:
 
-   ..code-block:: bash
+   .. code-block:: bash
+
       python -m http.server -d ./doc/_build/html
 
    Then open "localhost:8000" in browser
 
 
-Building documentation on main
-------------------------------
-The documentation updates are built on merge to ``main`` branch. This is done via GitHub Actions workflow based on ``/yfinance/.github/workflows/deploy_doc.yml``.
+Publishing documentation
+------------------------
+
+Merge into ``main`` branch triggers auto-generating documentation by action ``.github/workflows/deploy_doc.yml``.
+This publishes the generated HTML into branch ``documentation``.
 
 1. Review the changes locally and push to ``dev``.
 

doc/source/development/documentation.rst

@@ -2,12 +2,13 @@
 Development
 ===========
 
+yfinance relies on the community to investigate bugs and contribute code. Here's how you can help:
+
 .. toctree::
    :maxdepth: 1
 
-   contributing
+   code
    documentation
-   reporting_bug
    branches
    testing
    running