From 8b65a8c4b4efc697d5169a4de144f61ed32abca7 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Thu, 2 Jan 2025 00:22:24 -0500
Subject: [PATCH 01/11] add MacOS `venv` CLI note

---
 README.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8504bf7..3fcd4a3 100644
--- a/README.md
+++ b/README.md
@@ -76,7 +76,9 @@ I also installed these recommended extensions:
    sh .venv/Scripts/activate
    ```
 
-   > You can also use VSCode command: **Python: Create Environment ...** and then **Python: Select Interpreter** to pick your just created **venv** instance.  When done correctly, you should have a `.venv` folder in the root of your project folder.  There are other ways to initialize in a global environment; however, this is the recommended approach from [the Python tutorial](https://code.visualstudio.com/docs/python/python-tutorial) I'd mentioned above.
+   > You can also use VSCode command: **Python: Create Environment ...** and then **Python: Select Interpreter** to pick your just created **venv** instance.  The comparable MacOS command is `source venv/bin/activate`.
+   >
+   > When done correctly, you should have a `.venv` folder in the root of your project folder.  There are other ways to initialize in a global environment; however, this is the recommended approach from [the Python tutorial](https://code.visualstudio.com/docs/python/python-tutorial) I'd mentioned above.
 
 4. Install the [`stock-indicators`](https://pypi.org/project/stock-indicators) package from PyPI
 

From b7c25926263b37cf6357829e590436fa43593cd1 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Thu, 2 Jan 2025 00:57:29 -0500
Subject: [PATCH 02/11] update settings files

---
 .editorconfig           | 19 +++++++++++++++++++
 .gitattributes          |  2 ++
 .vscode/extensions.json |  5 +++++
 .vscode/settings.json   | 16 ++++++++++++++++
 4 files changed, 42 insertions(+)
 create mode 100644 .editorconfig
 create mode 100644 .gitattributes
 create mode 100644 .vscode/settings.json

diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..b88c27e
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,19 @@
+# EditorConfig: https://EditorConfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+indent_style = space
+indent_size = 2
+tab_width = 2
+
+[*.py]
+indent_style = space
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..9a5d6f3
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,2 @@
+# Normalize line endings.
+* text=auto eol=lf
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
index 0c084f1..5829e65 100644
--- a/.vscode/extensions.json
+++ b/.vscode/extensions.json
@@ -1,7 +1,12 @@
 {
     "recommendations": [
         "donjayamanne.python-extension-pack",
+        "ms-dotnettools.vscode-dotnet-runtime",
+        "ms-python.black-formatter",
         "ms-python.debugpy",
+        "ms-python.isort",
+        "ms-python.pylint",
+        "ms-python.python",
         "ms-python.vscode-pylance"
     ]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
new file mode 100644
index 0000000..607aa1c
--- /dev/null
+++ b/.vscode/settings.json
@@ -0,0 +1,16 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "always",                       // default: "never"
+    "source.organizeImports": "always"               // default: "never"
+  },
+  "editor.formatOnSave": true,                       // default: false
+
+  "isort.args": ["--profile", "black"],              // default: []
+  "isort.importStrategy": "fromEnvironment",         // default: "useBundled"
+
+  "pylint.importStrategy": "fromEnvironment",        // default: "useBundled"
+
+  "[python]": {
+    "editor.defaultFormatter": "ms-python.black-formatter" // default: null
+  }
+}

From d838aaa0389c01feaef5429dc79847bf65b4fd7a Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Thu, 2 Jan 2025 01:28:20 -0500
Subject: [PATCH 03/11] code sample cleanup

---
 main.py | 45 +++++++++++++++++++++++++++------------------
 1 file changed, 27 insertions(+), 18 deletions(-)

diff --git a/main.py b/main.py
index f434fda..5a8dce8 100644
--- a/main.py
+++ b/main.py
@@ -1,30 +1,39 @@
-"""Hello indicators!"""
+"""Hello indicators!"""  # calculate a Simple Moving Average (SMA)
+
+# Import what we need from stock-indicators package
 import csv
 from datetime import datetime
 from itertools import islice
 from stock_indicators import indicators, Quote
 
-# import csv file into interable list
-with open('quotes.csv', 'r', newline='', encoding="utf-8") as file:
+# Step 1: Get price history data from CSV file
+with open("quotes.csv", "r", newline="", encoding="utf-8") as file:
     rows = list(csv.reader(file))
-    file.close()
 
-# parse rows into quotes
+# Convert rows into Quote objects that stock-indicators understands
+# CSV returns strings, but Quote needs numbers for prices and volume
 quotes = []
-for row in rows[1:]: # skipping CSV file header row
-    quotes.append(Quote(
-        datetime.strptime(row[0], '%Y-%m-%d'), # date
-        row[1], # open
-        row[2], # high
-        row[3], # low
-        row[4], # close
-        row[5], # volume
-    ))
+for row in rows[1:]:  # skip header row
+    quotes.append(
+        Quote(
+            datetime.strptime(row[0], "%Y-%m-%d"),  # date
+            row[1],  # open
+            row[2],  # high
+            row[3],  # low
+            row[4],  # close
+            row[5],  # volume
+        )
+    )
 
-# calculate 5-period simple moving average
+# Step 2: Calculate 5-period Simple Moving Average
 results = indicators.get_sma(quotes, 5)
 
-# show the first 30 results, for brevity
+# Step 3: Show the results
 print("Date        SMA")
-for r in islice(results, 0, 30):
-    print(f"{r.date:%Y-%m-%d}  {r.sma or ''}")
+print("-" * 20)
+for r in islice(results, 0, 30):  # show first 30 days
+    sma = f"{r.sma:.3f}" if r.sma else ""
+    print(f"{r.date:%Y-%m-%d}  {sma}")
+
+# Try other indicators at:
+# https://python.stockindicators.dev/indicators

From 7d44be2cfbb1a7f8797aa20840afd12aa5f825e4 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Thu, 2 Jan 2025 01:40:41 -0500
Subject: [PATCH 04/11] update tutorial docs

---
 README.md | 189 +++++++++++++++++++++++++++---------------------------
 1 file changed, 94 insertions(+), 95 deletions(-)

diff --git a/README.md b/README.md
index 3fcd4a3..a033a93 100644
--- a/README.md
+++ b/README.md
@@ -1,93 +1,70 @@
-# Stock Indicators for Python: QuickStart guide
+<!-- markdownlint-disable MD029 -->
+# Stock Indicators for Python: QuickStart Guide
 
-These are the detailed steps to setup a Python project and to run your first finanical market price analysis with the [Stock Indicators for Python](https://python.stockindicators.dev) PyPI library package.  This guide is partly derived from the more detailed [Visual Studio Code Python Tutorial](https://code.visualstudio.com/docs/python/python-tutorial).
+A beginner's guide to setting up and using the [Stock Indicators for Python](https://python.stockindicators.dev) library for financial market analysis.
 
-> [!TIP]
-> **TLDR**, if you just want to quickly run this example, use these CLI commands:
->
-> ```bash
-> git clone https://github.com/facioquo/stock-indicators-python-quickstart.git
-> cd stock-indicators-python-quickstart
-> python -m venv .venv
-> sh .venv/Scripts/activate
-> pip install stock-indicators
-> python main.py
-> ```
->
-> or follow step-by-step instructions below
+## Quick Start
 
-## Install prerequisite software
+For the impatient, run these commands to get started immediately:
 
-These are the tools that I've already installed and will use in this guide.
+```bash
+git clone https://github.com/facioquo/stock-indicators-python-quickstart.git
+cd stock-indicators-python-quickstart
+python -m venv .venv
+source .venv/bin/activate  # On Windows use: .venv\Scripts\activate
+pip install stock-indicators
+python main.py
+```
 
-> [!NOTE]
-> *Don't sweat the OS*.  These instructions were written for Windows 11, but are the same for Mac and Linux OS; however, you may need different tool editions.
+## Prerequisites
 
-### Install Git
+Required software versions:
 
-- [Download and install Git for Windows](https://git-scm.com/download/win) for *git* and bash terminal CLI
+- [Python](https://www.python.org/downloads) ≥ 3.8
+- [.NET SDK](https://dotnet.microsoft.com/download) ≥ 6.0
+- [Git](https://git-scm.com/download) (any recent version)
+- [VS Code](https://code.visualstudio.com/download) (recommended)
 
-### Install Python v3
+VS Code Extensions:
 
-- [Download and install Python](https://www.python.org/downloads)
-
-   > I installed `v3.12.4`, the latest LTS version, using *administrative privileges*, for all users, and chose to add Python to my environment PATH variables.  We support `v3.8` or newer.
-
-   ```bash
-   # test with bash terminal command
-   python --version
-   > Python 3.12.4
-   ```
-
-### Install the .NET SDK
+- [Python Extension Pack](https://marketplace.visualstudio.com/items?itemName=donjayamanne.python-extension-pack) (includes primary Python extension)
+- [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
+- [Python Debugger](https://marketplace.visualstudio.com/items?itemName=ms-python.debugpy)
 
-- [Download and install .NET SDK](https://dotnet.microsoft.com/en-us/download/visual-studio-sdks)
+## Step-by-Step Setup
 
-   > I installed `v8.0.303`, the latest LTS version.  We support `v6` or newer.  We *do not* support Mono.
+0. **Install Prerequisites**
 
    ```bash
-   # test with bash terminal command
-   dotnet --version
-   > 8.0.303
+   # Verify installations
+   python --version   # Should be ≥ 3.8
+   dotnet --version   # Should be ≥ 6.0
    ```
 
-### Install the Visual Studio Code IDE
-
-- [Download and install VS Code](https://code.visualstudio.com/download)
-
-I also installed these recommended extensions:
-
-- [Python Extension Pack](https://marketplace.visualstudio.com/items?itemName=donjayamanne.python-extension-pack) (includes primary Python extension)
-- [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
-- [Python Debugger](https://marketplace.visualstudio.com/items?itemName=ms-python.debugpy)
-
-## Setup your project
-
-1. Create a new project folder.
-2. Optional: initialize a *git repository* in this folder with `git init` bash command and add a Python flavored [`.gitignore`](.gitignore) file.  I found this one in [the *gitignore* templates repo](https://github.com/github/gitignore/blob/4488915eec0b3a45b5c63ead28f286819c0917de/Python.gitignore).
-3. Initialize Python workspace with a [virtual environment](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments) (a cached instance):
+1. **Create a new project folder.**
+2. **Optional: initialize a *git repository* in this folder with `git init` bash command and add a Python flavored [`.gitignore`](.gitignore) file.**  I found this one in [the *gitignore* templates repo](https://github.com/github/gitignore/blob/4488915eec0b3a45b5c63ead28f286819c0917de/Python.gitignore).
+3. **Initialize Python workspace with a [virtual environment](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments) (a cached instance):**
 
    ```bash
-   # git bash commands
    # create environment
    python -m venv .venv
 
    # then activate it
-   sh .venv/Scripts/activate
+   source .venv/bin/activate  # On Windows use: .venv\Scripts\activate
    ```
 
    > You can also use VSCode command: **Python: Create Environment ...** and then **Python: Select Interpreter** to pick your just created **venv** instance.  The comparable MacOS command is `source venv/bin/activate`.
    >
    > When done correctly, you should have a `.venv` folder in the root of your project folder.  There are other ways to initialize in a global environment; however, this is the recommended approach from [the Python tutorial](https://code.visualstudio.com/docs/python/python-tutorial) I'd mentioned above.
 
-4. Install the [`stock-indicators`](https://pypi.org/project/stock-indicators) package from PyPI
+4. **Install the [`stock-indicators`](https://pypi.org/project/stock-indicators) package from PyPI**
 
    ```bash
    # bash terminal command
    pip install stock-indicators
    ```
 
-   > I'm using `v1.3.0`, the latest version.  You should see it installed in `.venv/Lib/site-packages`.
+   > I'm using `v1.3.1`, the latest version.  You should see it installed in `.venv/Lib/site-packages`.
 
    ```bash
    # test with bash terminal command
@@ -96,10 +73,10 @@ I also installed these recommended extensions:
 
    ```console
    ...
-   clr-loader==0.2.6
+   clr-loader==0.2.7
    pycparser==2.22
-   pythonnet==3.0.3
-   stock-indicators==1.3.0
+   pythonnet==3.0.5
+   stock-indicators==1.3.1
    typing_extensions==4.12.2
    ...
    ```
@@ -108,9 +85,9 @@ I also installed these recommended extensions:
 
 It's time to start writing some code.
 
-5. To start, add a [`quotes.csv`](quotes.csv) file containing historical financial market prices in OHLCV format.  Use the one I put in this repo.  You can worry about all the available [stock quote sources](https://github.com/DaveSkender/Stock.Indicators/discussions/579) later.
+5. **To start, add a [`quotes.csv`](quotes.csv) file containing historical financial market prices in OHLCV format.**  Use the one I put in this repo.  You can worry about all the available [stock quote sources](https://github.com/DaveSkender/Stock.Indicators/discussions/579) later.
 
-6. Create a [`main.py`](main.py) file and import the utilities we'll be using at the top of it.
+6. **Create a [`main.py`](main.py) file and import the utilities we'll be using at the top of it.**
 
    ```python
    import csv
@@ -119,48 +96,51 @@ It's time to start writing some code.
    from stock_indicators import indicators, Quote
    ```
 
-7. Import the data from [the CSV file](quotes.csv) and convert it into an iterable list of the `Quote` class.
+7. **Import the data from [the CSV file](quotes.csv) and convert it into an iterable list of the `Quote` class.**
 
    ```python
-   # import each row of the csv file into a raw iterable string list
-   with open('quotes.csv', 'r', newline='', encoding="utf-8") as file:
+   # Get price history data from CSV file
+   with open("quotes.csv", "r", newline="", encoding="utf-8") as file:
       rows = list(csv.reader(file))
-      file.close()
 
-   # parse each row into proper `Quote` format
+   # Convert rows into Quote objects that stock-indicators understands
+   # CSV returns strings, but Quote needs numbers for prices and volume
    quotes = []
-   for row in rows[1:]: # skipping CSV file header row
-      quotes.append(Quote(
-         datetime.strptime(row[0], '%Y-%m-%d'), # date
-         row[1], # open
-         row[2], # high
-         row[3], # low
-         row[4], # close
-         row[5], # volume
-      ))
+   for row in rows[1:]:  # skip header row
+      quotes.append(
+         Quote(
+            datetime.strptime(row[0], "%Y-%m-%d"),  # date
+            row[1],  # open
+            row[2],  # high
+            row[3],  # low
+            row[4],  # close
+            row[5],  # volume
+         )
+      )
    ```
 
    > These `quotes` can now be used by the `stock-indicators` library.  For a quickstart that uses **pandas.DataFrame**, see our online *ReplIt* code example for the [Williams Fractal indicator](https://replit.com/@daveskender/Stock-Indicators-for-Python-Williams-Fractal).
 
-8. Calculate [an indicator](https://python.stockindicators.dev/indicators/) from the `quotes`
+8. **Calculate [an indicator](https://python.stockindicators.dev/indicators/) from the `quotes`**
 
    ```python
-   # calculate 5-period simple moving average
+   # Calculate 5-period Simple Moving Average
    results = indicators.get_sma(quotes, 5)
    ```
 
-9. Configure `results` for console output
+9. **Configure `results` for console output**
 
    ```python
-   # show the first 30 periods, for brevity
+   # Show the results
    print("Date        SMA")
-   for r in islice(results, 0, 30):
-      print(f"{r.date:%Y-%m-%d}  {r.sma or ''}")
+   for r in islice(results, 0, 30):  # show first 30 days
+      sma = f"{r.sma:.3f}" if r.sma else ""
+      print(f"{r.date:%Y-%m-%d}  {sma}")
    ```
 
 ## Run the code
 
-10. Click the ***Run Python File in Terminal*** (&#9658;) play button in the top-right side of the VS Code editor to run the code, or execute from the commandline in your bash terminal.  The SMA indicator output will print to the console.
+10. **Click the ***Run Python File in Terminal*** (&#9658;) play button in the top-right side of the VS Code editor to run the code, or execute from the commandline in your bash terminal.**  The SMA indicator output will print to the console.
 
    ```bash
    # from CLI (optional)
@@ -169,32 +149,51 @@ It's time to start writing some code.
 
    ```console
    Date        SMA
+   --------------------
    2017-01-03
    2017-01-04
    2017-01-05
    2017-01-06
-   2017-01-09  213.87199999999999
+   2017-01-09  213.872
    2017-01-10  214.102
-   2017-01-11  214.2
-   2017-01-12  214.22599999999997
+   2017-01-11  214.200
+   2017-01-12  214.226
    2017-01-13  214.196
    2017-01-17  214.156
-   2017-01-18  214.20999999999998
-   2017-01-19  213.98600000000002
-   2017-01-20  214.02400000000003
+   2017-01-18  214.210
+   2017-01-19  213.986
+   2017-01-20  214.024
    ...
    ```
 
-   > The small deviations shown in these raw results are normal for `double` floating point precision data types.  They're not *programming errors*.  Developers will usually truncate or round to fewer significant digits when displaying.
+   > The small deviations shown in these raw results are normal for `double` floating point precision data types.  They're not *programming errors*.  Developers will usually truncate or round to fewer significant digits when displaying.  We're showing 3 decimal places here.
 
 **You've done it!**  That's the end of this QuickStart guide.
 
-## Still having trouble getting started?
+---
+
+## Common Issues
+
+- **Import Errors**: Ensure you've activated the virtual environment
+- **Runtime Errors**: Verify .NET SDK installation
+- **.NET Loading Issues**: On Linux/MacOS, you may need additional dependencies
+
+## Next Steps
+
+- Explore [all available indicators](https://python.stockindicators.dev/indicators/)
+- Learn about [data sources](https://github.com/DaveSkender/Stock.Indicators/discussions/579)
+- Join our [community discussions](https://github.com/DaveSkender/Stock.Indicators/discussions)
+
+## Getting Help
+
+Having trouble? Try these resources:
 
-Ask a question in our [open community help and support discussions](https://github.com/DaveSkender/Stock.Indicators/discussions/categories/help-and-support).
+1. [Documentation](https://python.stockindicators.dev)
+2. [GitHub Discussions](https://github.com/DaveSkender/Stock.Indicators/discussions)
+3. [Stack Overflow](https://stackoverflow.com/questions/tagged/stock-indicators)
 
-And if you end up building something wonderful, come back and [share it with us](https://github.com/DaveSkender/Stock.Indicators/discussions/categories/show-and-tell).  We love &#128150; to see all the creative ways people are using the library.
+## Share Your Work
 
-Good luck &#127808; and have fun in building your systems!
+Built something cool? [Share it](https://github.com/DaveSkender/Stock.Indicators/discussions/categories/show-and-tell) with the community!
 
--- @DaveSkender, July 2024
+-- @DaveSkender, January 2025

From 825f2f2c4088e86bce4d6bc7da8b52797d0117bb Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Thu, 2 Jan 2025 01:46:17 -0500
Subject: [PATCH 05/11] update GitHub Action workflows

---
 .../workflows/{pylint.yml => lint-code.yml}   | 13 ++++---
 .github/workflows/lint-pull-request.yml       | 35 +++++++++----------
 2 files changed, 25 insertions(+), 23 deletions(-)
 rename .github/workflows/{pylint.yml => lint-code.yml} (69%)

diff --git a/.github/workflows/pylint.yml b/.github/workflows/lint-code.yml
similarity index 69%
rename from .github/workflows/pylint.yml
rename to .github/workflows/lint-code.yml
index 0d75c1f..8b9c6c9 100644
--- a/.github/workflows/pylint.yml
+++ b/.github/workflows/lint-code.yml
@@ -7,18 +7,23 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.8", "3.10", "3.12"]
     steps:
-    - uses: actions/checkout@v3
+
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install stock-indicators==1.2.1
+        pip install stock-indicators==1.3.1
         pip install pylint
+
     - name: Analysing the code with pylint
       run: |
         pylint $(git ls-files '*.py')
diff --git a/.github/workflows/lint-pull-request.yml b/.github/workflows/lint-pull-request.yml
index 0be571c..48eb9a3 100644
--- a/.github/workflows/lint-pull-request.yml
+++ b/.github/workflows/lint-pull-request.yml
@@ -1,4 +1,4 @@
-name: "Pull request"
+name: Pull request
 
 on:
   pull_request_target:
@@ -14,6 +14,7 @@ jobs:
   main:
     name: lint PR title
     runs-on: ubuntu-latest
+
     steps:
       - uses: amannn/action-semantic-pull-request@v5
         id: lint_pr_title
@@ -29,9 +30,8 @@ jobs:
           # the default error message that is shown when the pattern doesn't match.
           # The variables `subject` and `title` can be used within the message.
           subjectPatternError: >
-            The subject "**{subject}**" found in the pull request title "*{title}*"
-            didn't match the configured pattern. Please ensure that the subject
-            starts with an uppercase character.
+            The subject "**{subject}**" in pull request "*{title}*"
+            needs to start with an uppercase character.
 
           # If the PR contains one of these newline-delimited labels, the
           # validation is skipped. If you want to rerun the validation when
@@ -47,25 +47,22 @@ jobs:
         if: always() && (steps.lint_pr_title.outputs.error_message != null)
         with:
           header: pr-title-lint-error
-          message: >
-            ### Hey there and thank you for opening this pull request! 👋🏼
-
-            It looks like your proposed **_Pull request title_** needs to be adjusted.
-
-            >🚩 **Error** » ${{ steps.lint_pr_title.outputs.error_message }}
+          message: |
+            ### ⚠️ Pull Request title needs adjustment
 
-            #### Pull request title naming convention
+            Your PR title doesn't match our naming convention: `type: Subject`
 
-            Our PR title name taxonomy is `type: Subject`, where **type** is typically
-            *feat*, *fix*, or *chore*, and **subject** is a phrase (proper noun) that starts
-            with a capitalized letter.  The *chore* type usually has a subject that starts
-            with an action verb like *Add* or *Update*. Examples:
+            > [!CAUTION]
+            > ${{ steps.lint_pr_title.outputs.error_message }}
 
-            - _feat: Admin portal login_
-            - _fix: Divide by zero bug in SMA_
-            - _chore: Update packages_
-            - _docs: Improve setup guidance_
+            #### Valid examples
 
+            - `feat: Add new RSI indicator`
+            - `fix: Correct MACD calculation`
+            - `chore: Update documentation`
+            - `test: Add unit tests for EMA`
+            - `refactor: Optimize moving average logic`
+            
             See the [Conventional Commits specification](https://www.conventionalcommits.org) for more information.
 
       # Delete a previous comment when the issue has been resolved

From 1b085b37d01015965338c815ab040a25ce107fdd Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Thu, 2 Jan 2025 01:49:58 -0500
Subject: [PATCH 06/11] fix: typo with macOS

---
 README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index a033a93..f69dbfa 100644
--- a/README.md
+++ b/README.md
@@ -53,7 +53,7 @@ VS Code Extensions:
    source .venv/bin/activate  # On Windows use: .venv\Scripts\activate
    ```
 
-   > You can also use VSCode command: **Python: Create Environment ...** and then **Python: Select Interpreter** to pick your just created **venv** instance.  The comparable MacOS command is `source venv/bin/activate`.
+   > You can also use VSCode command: **Python: Create Environment ...** and then **Python: Select Interpreter** to pick your just created **venv** instance.  The comparable macOS command is `source venv/bin/activate`.
    >
    > When done correctly, you should have a `.venv` folder in the root of your project folder.  There are other ways to initialize in a global environment; however, this is the recommended approach from [the Python tutorial](https://code.visualstudio.com/docs/python/python-tutorial) I'd mentioned above.
 
@@ -176,7 +176,7 @@ It's time to start writing some code.
 
 - **Import Errors**: Ensure you've activated the virtual environment
 - **Runtime Errors**: Verify .NET SDK installation
-- **.NET Loading Issues**: On Linux/MacOS, you may need additional dependencies
+- **.NET Loading Issues**: On Linux/macOS, you may need additional dependencies
 
 ## Next Steps
 

From e98b5c7b0dfec508e30fd18df7260f3de1e464f7 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Thu, 2 Jan 2025 02:03:13 -0500
Subject: [PATCH 07/11] cosmetic cleanup

---
 README.md | 71 +++++++++++++++++++++++++++----------------------------
 1 file changed, 35 insertions(+), 36 deletions(-)

diff --git a/README.md b/README.md
index f69dbfa..f0bd038 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,9 @@ pip install stock-indicators
 python main.py
 ```
 
-## Prerequisites
+## Step-by-Step Setup
+
+1. **Prerequisites**
 
 Required software versions:
 
@@ -31,18 +33,15 @@ VS Code Extensions:
 - [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
 - [Python Debugger](https://marketplace.visualstudio.com/items?itemName=ms-python.debugpy)
 
-## Step-by-Step Setup
-
-0. **Install Prerequisites**
-
    ```bash
    # Verify installations
    python --version   # Should be ≥ 3.8
    dotnet --version   # Should be ≥ 6.0
    ```
 
-1. **Create a new project folder.**
-2. **Optional: initialize a *git repository* in this folder with `git init` bash command and add a Python flavored [`.gitignore`](.gitignore) file.**  I found this one in [the *gitignore* templates repo](https://github.com/github/gitignore/blob/4488915eec0b3a45b5c63ead28f286819c0917de/Python.gitignore).
+2. **Create a new project folder.**
+   > _**Optional**: initialize a `git` repository in this folder with `git init` bash command and add a Python flavored [`.gitignore`](.gitignore) file._  I found this one in [the _gitignore templates_ repo](https://github.com/github/gitignore/blob/4488915eec0b3a45b5c63ead28f286819c0917de/Python.gitignore).
+
 3. **Initialize Python workspace with a [virtual environment](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments) (a cached instance):**
 
    ```bash
@@ -119,7 +118,7 @@ It's time to start writing some code.
       )
    ```
 
-   > These `quotes` can now be used by the `stock-indicators` library.  For a quickstart that uses **pandas.DataFrame**, see our online *ReplIt* code example for the [Williams Fractal indicator](https://replit.com/@daveskender/Stock-Indicators-for-Python-Williams-Fractal).
+   > These `quotes` can now be used by the `stock-indicators` library.  For a quickstart that uses **pandas.DataFrame**, see our online _ReplIt_ code example for the [Williams Fractal indicator](https://replit.com/@daveskender/Stock-Indicators-for-Python-Williams-Fractal).
 
 8. **Calculate [an indicator](https://python.stockindicators.dev/indicators/) from the `quotes`**
 
@@ -140,33 +139,33 @@ It's time to start writing some code.
 
 ## Run the code
 
-10. **Click the ***Run Python File in Terminal*** (&#9658;) play button in the top-right side of the VS Code editor to run the code, or execute from the commandline in your bash terminal.**  The SMA indicator output will print to the console.
-
-   ```bash
-   # from CLI (optional)
-   python main.py
-   ```
-
-   ```console
-   Date        SMA
-   --------------------
-   2017-01-03
-   2017-01-04
-   2017-01-05
-   2017-01-06
-   2017-01-09  213.872
-   2017-01-10  214.102
-   2017-01-11  214.200
-   2017-01-12  214.226
-   2017-01-13  214.196
-   2017-01-17  214.156
-   2017-01-18  214.210
-   2017-01-19  213.986
-   2017-01-20  214.024
-   ...
-   ```
-
-   > The small deviations shown in these raw results are normal for `double` floating point precision data types.  They're not *programming errors*.  Developers will usually truncate or round to fewer significant digits when displaying.  We're showing 3 decimal places here.
+10. **Click the _**Run Python File in Terminal**_ (&#9658;) play button in the top-right side of the VS Code editor to run the code, or execute from the commandline in your bash terminal.**  The SMA indicator output will print to the console.
+
+    ```bash
+    # from CLI (optional)
+    python main.py
+    ```
+
+    ```console
+    Date        SMA
+    --------------------
+    2017-01-03
+    2017-01-04
+    2017-01-05
+    2017-01-06
+    2017-01-09  213.872
+    2017-01-10  214.102
+    2017-01-11  214.200
+    2017-01-12  214.226
+    2017-01-13  214.196
+    2017-01-17  214.156
+    2017-01-18  214.210
+    2017-01-19  213.986
+    2017-01-20  214.024
+    ...
+    ```
+
+    > The small deviations shown in these raw results are normal for `double` floating point precision data types.  They're not _programming errors_.  Developers will usually truncate or round to fewer significant digits when displaying.  We're showing 3 decimal places here.
 
 **You've done it!**  That's the end of this QuickStart guide.
 
@@ -196,4 +195,4 @@ Having trouble? Try these resources:
 
 Built something cool? [Share it](https://github.com/DaveSkender/Stock.Indicators/discussions/categories/show-and-tell) with the community!
 
--- @DaveSkender, January 2025
+— @DaveSkender, January 2025

From fa4c8aeb6ee5fa98afb0b45fa09ea570658d151e Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Thu, 2 Jan 2025 02:05:20 -0500
Subject: [PATCH 08/11] remove extra header

---
 README.md | 2 --
 1 file changed, 2 deletions(-)

diff --git a/README.md b/README.md
index f0bd038..85b33ef 100644
--- a/README.md
+++ b/README.md
@@ -3,8 +3,6 @@
 
 A beginner's guide to setting up and using the [Stock Indicators for Python](https://python.stockindicators.dev) library for financial market analysis.
 
-## Quick Start
-
 For the impatient, run these commands to get started immediately:
 
 ```bash

From 8e98fd3530da75a56d1cd7406cb53840cfdd705d Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Thu, 2 Jan 2025 02:18:58 -0500
Subject: [PATCH 09/11] more cosmetic updates

---
 README.md | 82 +++++++++++++++++++++++++++++--------------------------
 1 file changed, 43 insertions(+), 39 deletions(-)

diff --git a/README.md b/README.md
index 85b33ef..17ee544 100644
--- a/README.md
+++ b/README.md
@@ -3,20 +3,21 @@
 
 A beginner's guide to setting up and using the [Stock Indicators for Python](https://python.stockindicators.dev) library for financial market analysis.
 
-For the impatient, run these commands to get started immediately:
-
-```bash
-git clone https://github.com/facioquo/stock-indicators-python-quickstart.git
-cd stock-indicators-python-quickstart
-python -m venv .venv
-source .venv/bin/activate  # On Windows use: .venv\Scripts\activate
-pip install stock-indicators
-python main.py
-```
-
-## Step-by-Step Setup
-
-1. **Prerequisites**
+> [!TIP]
+> **TLDR**, for the impatient, run these commands to fast-forward this tutorial:
+>
+> ```bash
+> git clone https://github.com/facioquo/stock-indicators-python-quickstart.git
+> cd stock-indicators-python-quickstart
+> python -m venv .venv
+> source .venv/bin/activate  # On Windows use: .venv\Scripts\activate
+> pip install stock-indicators
+> python main.py
+> ```
+>
+> or follow step-by-step instructions below
+
+## Install prerequisite software
 
 Required software versions:
 
@@ -31,16 +32,19 @@ VS Code Extensions:
 - [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
 - [Python Debugger](https://marketplace.visualstudio.com/items?itemName=ms-python.debugpy)
 
-   ```bash
-   # Verify installations
-   python --version   # Should be ≥ 3.8
-   dotnet --version   # Should be ≥ 6.0
-   ```
+```bash
+# Verify installations
+python --version   # Should be ≥ 3.8
+dotnet --version   # Should be ≥ 6.0
+```
+
+## Setup your project
+
+1. **Create a new project folder.**
 
-2. **Create a new project folder.**
-   > _**Optional**: initialize a `git` repository in this folder with `git init` bash command and add a Python flavored [`.gitignore`](.gitignore) file._  I found this one in [the _gitignore templates_ repo](https://github.com/github/gitignore/blob/4488915eec0b3a45b5c63ead28f286819c0917de/Python.gitignore).
+2. _**Optional**: initialize a `git` repository in this folder with `git init` bash command and add a Python flavored [`.gitignore`](.gitignore) file._  I found this one in [the _gitignore templates_ repo](https://github.com/github/gitignore/blob/4488915eec0b3a45b5c63ead28f286819c0917de/Python.gitignore).
 
-3. **Initialize Python workspace with a [virtual environment](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments) (a cached instance):**
+3. **Initialize Python workspace** with a [_virtual environment_](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments) (a cached instance):
 
    ```bash
    # create environment
@@ -54,7 +58,7 @@ VS Code Extensions:
    >
    > When done correctly, you should have a `.venv` folder in the root of your project folder.  There are other ways to initialize in a global environment; however, this is the recommended approach from [the Python tutorial](https://code.visualstudio.com/docs/python/python-tutorial) I'd mentioned above.
 
-4. **Install the [`stock-indicators`](https://pypi.org/project/stock-indicators) package from PyPI**
+4. **Install the [`stock-indicators`](https://pypi.org/project/stock-indicators) package** from PyPI
 
    ```bash
    # bash terminal command
@@ -82,7 +86,7 @@ VS Code Extensions:
 
 It's time to start writing some code.
 
-5. **To start, add a [`quotes.csv`](quotes.csv) file containing historical financial market prices in OHLCV format.**  Use the one I put in this repo.  You can worry about all the available [stock quote sources](https://github.com/DaveSkender/Stock.Indicators/discussions/579) later.
+5. To start, **add a [`quotes.csv`](quotes.csv) file** containing historical financial market prices in OHLCV format.  Use the one I put in this repo.  You can worry about all the available [stock quote sources](https://github.com/DaveSkender/Stock.Indicators/discussions/579) later.
 
 6. **Create a [`main.py`](main.py) file and import the utilities we'll be using at the top of it.**
 
@@ -93,7 +97,7 @@ It's time to start writing some code.
    from stock_indicators import indicators, Quote
    ```
 
-7. **Import the data from [the CSV file](quotes.csv) and convert it into an iterable list of the `Quote` class.**
+7. **Import the data** from [the CSV file](quotes.csv) and convert it into an iterable list of the `Quote` class.
 
    ```python
    # Get price history data from CSV file
@@ -118,14 +122,14 @@ It's time to start writing some code.
 
    > These `quotes` can now be used by the `stock-indicators` library.  For a quickstart that uses **pandas.DataFrame**, see our online _ReplIt_ code example for the [Williams Fractal indicator](https://replit.com/@daveskender/Stock-Indicators-for-Python-Williams-Fractal).
 
-8. **Calculate [an indicator](https://python.stockindicators.dev/indicators/) from the `quotes`**
+8. **Calculate [an indicator](https://python.stockindicators.dev/indicators/)** from the `quotes`
 
    ```python
    # Calculate 5-period Simple Moving Average
    results = indicators.get_sma(quotes, 5)
    ```
 
-9. **Configure `results` for console output**
+9. **Configure `results`** for console output
 
    ```python
    # Show the results
@@ -137,7 +141,7 @@ It's time to start writing some code.
 
 ## Run the code
 
-10. **Click the _**Run Python File in Terminal**_ (&#9658;) play button in the top-right side of the VS Code editor to run the code, or execute from the commandline in your bash terminal.**  The SMA indicator output will print to the console.
+10. Click the _**Run Python File in Terminal**_ (&#9658;) play button in the top-right side of the VS Code editor to run the code, or execute from the commandline in your bash terminal.  The SMA indicator output will print to the console.
 
     ```bash
     # from CLI (optional)
@@ -169,28 +173,28 @@ It's time to start writing some code.
 
 ---
 
-## Common Issues
+## Common issues
 
-- **Import Errors**: Ensure you've activated the virtual environment
-- **Runtime Errors**: Verify .NET SDK installation
-- **.NET Loading Issues**: On Linux/macOS, you may need additional dependencies
+- **Import errors**: Ensure you've activated the virtual environment
+- **Runtime errors**: Verify .NET SDK installation
+- **.NET loading issues**: On Linux/macOS, you may need additional dependencies
 
-## Next Steps
+## Next steps
 
 - Explore [all available indicators](https://python.stockindicators.dev/indicators/)
 - Learn about [data sources](https://github.com/DaveSkender/Stock.Indicators/discussions/579)
 - Join our [community discussions](https://github.com/DaveSkender/Stock.Indicators/discussions)
 
-## Getting Help
+## Getting help
 
 Having trouble? Try these resources:
 
-1. [Documentation](https://python.stockindicators.dev)
-2. [GitHub Discussions](https://github.com/DaveSkender/Stock.Indicators/discussions)
-3. [Stack Overflow](https://stackoverflow.com/questions/tagged/stock-indicators)
+- [Documentation](https://python.stockindicators.dev)
+- [GitHub Discussions](https://github.com/DaveSkender/Stock.Indicators/discussions)
+- [Stack Overflow](https://stackoverflow.com/questions/tagged/stock-indicators)
 
-## Share Your Work
+## Share your work
 
-Built something cool? [Share it](https://github.com/DaveSkender/Stock.Indicators/discussions/categories/show-and-tell) with the community!
+**Built something cool?** [Share it](https://github.com/DaveSkender/Stock.Indicators/discussions/categories/show-and-tell) with the community!
 
 — @DaveSkender, January 2025

From 2c52575aa4f663193f9c8b778235a2ca9d8b41c4 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Thu, 2 Jan 2025 02:22:03 -0500
Subject: [PATCH 10/11] remove superfluous code comments

---
 README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 17ee544..77403fb 100644
--- a/README.md
+++ b/README.md
@@ -61,14 +61,14 @@ dotnet --version   # Should be ≥ 6.0
 4. **Install the [`stock-indicators`](https://pypi.org/project/stock-indicators) package** from PyPI
 
    ```bash
-   # bash terminal command
+   # install the package
    pip install stock-indicators
    ```
 
    > I'm using `v1.3.1`, the latest version.  You should see it installed in `.venv/Lib/site-packages`.
 
    ```bash
-   # test with bash terminal command
+   # verify the install
    pip freeze --local
    ```
 

From ca215f722eacf7300d570decbe5e8a834643c787 Mon Sep 17 00:00:00 2001
From: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Date: Thu, 2 Jan 2025 02:26:40 -0500
Subject: [PATCH 11/11] another minor tweak

---
 README.md | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 77403fb..9fba18d 100644
--- a/README.md
+++ b/README.md
@@ -54,9 +54,7 @@ dotnet --version   # Should be ≥ 6.0
    source .venv/bin/activate  # On Windows use: .venv\Scripts\activate
    ```
 
-   > You can also use VSCode command: **Python: Create Environment ...** and then **Python: Select Interpreter** to pick your just created **venv** instance.  The comparable macOS command is `source venv/bin/activate`.
-   >
-   > When done correctly, you should have a `.venv` folder in the root of your project folder.  There are other ways to initialize in a global environment; however, this is the recommended approach from [the Python tutorial](https://code.visualstudio.com/docs/python/python-tutorial) I'd mentioned above.
+   > You can also use VS Code command: **Python: Create Environment ...** and then **Python: Select Interpreter** to pick your just created **venv** instance.  When done correctly, you should have a `.venv` folder in the root of your project folder.  There are other ways to initialize in a global environment; however, this is the recommended approach from [the Python tutorial](https://code.visualstudio.com/docs/python/python-tutorial) I'd mentioned above.
 
 4. **Install the [`stock-indicators`](https://pypi.org/project/stock-indicators) package** from PyPI