Upload 25 files

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[Bug]"
+labels: 'type:bug'
+assignees: ''
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps(from the start) and commands to reproduce the behavior
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+If you are running the terminal using the conda version please
+rerun the terminal with `python terminal.py --debug`, and then
+recreate your issue. Then include a screenshot of the entire 
+error printout.
+
+**Desktop (please complete the following information):**
+
+- OS: [e.g. Mac Sierra]
+- Python version [e.g. 3.6.8]
+
+**Additional context**
+Add any other information that you think could be useful for us.

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,20 @@
+---
+name: Improvement
+about: Improve something on this project
+title: "[IMPROVE]"
+labels: 'type:enhancement'
+assignees: ''
+
+---
+
+**What's the feature that should be improved?**
+A description of what's the feature you want improved, and a bit of context (why is that).
+
+**Describe how you would like the feature improved**
+A description of what the current feature is vs what it would be after your suggestion.
+
+**Possibly describe the ideal way to improve this**
+If you have thought about how you would do it, add it here.
+
+**Additional information**
+Add any other information or screenshots about the feature improvement.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FR]"
+labels: 'type:feature'
+assignees: ''
+
+---
+
+**What's the problem of not having this feature?**
+A clear description of what you are lacking, or why you need this additional feature.
+
+**Describe the solution you would like**
+A description of what you think would be the best solution for this. From user inputs, to an output.
+
+**Describe alternatives you've considered**
+If there are other alternatives (worth considering) to your solution, list them here. 
+
+**Additional information**
+Add any other information or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/oss-gg-hack-submission.yml

@@ -0,0 +1,33 @@
+name: oss.gg hack submission 🕹️
+description: "Submit your contribution for the for the oss.gg hackathon"
+title: "[🕹️]"
+labels: 🕹️ oss.gg, player submission, hacktoberfest
+assignees: []
+body:
+  - type: textarea
+    id: contribution-name
+    attributes:
+      label: What side quest or challenge are you solving?
+      description: Add the name of the side quest or challenge.
+    validations:
+      required: true
+  - type: textarea
+    id: points
+    attributes:
+      label: Points
+      description: How many points are assigned to this contribution?
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: What's the task your performed?
+    validations:
+  - type: textarea
+    id: proof
+    attributes:
+      label: Provide proof that you've completed the task
+      description: Screenshots, loom recordings, links to the content you shared or interacted with.
+    validations:
+      required: true

.github/PULL_REQUEST_TEMPLATE/obb_developer_pull_request_template.md

@@ -0,0 +1,40 @@
+# Pull Request Template for OpenBB Developers
+
+0. **Title**:
+
+    - Format: [Type] - Brief Description (e.g., [Hotfix] - Improve Calculation Accuracy).
+
+1. **Why**? (1-3 sentences or a bullet point list):
+
+    - State the primary reason for this change.
+
+    - Example: "To enhance the accuracy of our risk calculation in response to recent market volatility."
+
+2. **What**? (1-3 sentences or a bullet point list):
+
+    - Describe what has been done in simple terms.
+
+    - Example: "Updated the risk calculation algorithm to factor in real-time market fluctuations."
+
+3. **Impact** (1-2 sentences or a bullet point list):
+
+    - Briefly note the expected outcome or any potential risks and share the Impact Analysis score.
+
+    - Example: "Expected to improve risk assessment accuracy by 15%, with minimal performance impact. Impact score: 10"
+
+    > [!TIP]
+    > Refer to the Impact Analysis confluence (internal) document for more information.
+
+4. **Testing Done**:
+
+    - A quick note on how it was tested.
+
+    - Example: "Validated with historical market data and simulated scenarios."
+
+5. **Reviewer Notes** (optional):
+
+    - Any specific focus areas for review?
+
+    - Example: "Please check algorithm compatibility with existing data models."
+
+6. **Any other information** (optional)

.github/PULL_REQUEST_TEMPLATE/platform_pull_request_template.md

@@ -0,0 +1,40 @@
+# Pull Request the OpenBB Platform
+
+## Description
+
+- [ ] Summary of the change/ bug fix.
+- [ ] Link # issue, if applicable.
+- [ ] Screenshot of the feature or the bug before/after fix, if applicable.
+- [ ] Relevant motivation and context.
+- [ ] List any dependencies that are required for this change.
+
+## How has this been tested?
+
+- Please describe the tests that you ran to verify your changes.
+- Please provide instructions so we can reproduce.
+- Please also list any relevant details for your test configuration.
+
+- [ ] Ensure all unit and integration tests pass.
+- If you modified/added command(s):
+  - [ ] Ensure the command(s) execute with the expected output.
+    - [ ] API.
+    - [ ] Python Interface.
+  - [ ] If applicable, please add new tests for the command (see [CONTRIBUTING.md](/openbb_platform/CONTRIBUTING.md) to leverage semi-automated testing).
+- If a new provider was introduced or a new fetcher was added to an existing provider:
+  - [ ] Ensure the existing tests pass.
+  - [ ] Ensure the new provider and/or fetcher is stable and usable.
+  - [ ] If applicable, please add new tests for the provider and/or fetcher (see [CONTRIBUTING.md](/openbb_platform/CONTRIBUTING.md) to leverage semi-automated testing).
+- If a new provider or extension was added:
+  - [ ] Update the list of [Extensions](/openbb_platform/EXTENSIONS.md).
+  - [ ] Update the list of [Providers](/openbb_platform/PROVIDERS.md).
+  - [ ] If it's a community extension or provider, update the [integration tests GitHub Action workflow](/.github/workflows/platform-api-integration-test.yml).
+
+## Checklist
+
+- [ ] I have performed a self-review of my own code.
+- [ ] I have commented my code, particularly in hard-to-understand areas.
+- [ ] I have adhered to the GitFlow naming convention and my branch name is in the format of `feature/feature-name` or `hotfix/hotfix-name`.
+- [ ] I ensure that I am following the [CONTRIBUTING guidelines](https://github.com/OpenBB-finance/OpenBB/blob/main/CONTRIBUTING.md).
+  - [ ] (If applicable) I have updated tests following [these guidelines](/openbb_platform/CONTRIBUTING.md#qa-your-extension).
+
+</details>

.github/PULL_REQUEST_TEMPLATE/terminal_pull_request_template.md

@@ -0,0 +1,29 @@
+# Pull Request the OpenBB Platform CLI
+
+## Description
+
+- [ ] Summary of the change/ bug fix.
+- [ ] Link # issue, if applicable.
+- [ ] Screenshot of the feature or the bug before/after fix, if applicable.
+- [ ] Relevant motivation and context.
+- [ ] List any dependencies that are required for this change.
+
+## How has this been tested?
+
+- Please describe the tests that you ran to verify your changes.
+- Please provide instructions so we can reproduce.
+- Please also list any relevant details for your test configuration.
+
+- [ ] Ensure the affected commands still execute in the OpenBB Platform CLI.
+- [ ] Ensure the Platform is working as intended.
+- [ ] Check any related reports.
+
+## Checklist
+
+- [ ] I ensure I have self-reviewed my code.
+- [ ] I have commented/documented my code, particularly in hard-to-understand sections.
+- [ ] I have adhered to the GitFlow naming convention and my branch name is in the format of `feature/feature-name` or `hotfix/hotfix-name`.
+- [ ] Update [our documentation](https://openbb-finance.github.io/OpenBBTerminal/) following [these guidelines](https://github.com/OpenBB-finance/OpenBB/tree/main/website).  Update any user guides that are affected by the changes.
+- [ ] Update our tests following [these guidelines](https://github.com/OpenBB-finance/OpenBB/tree/main/tests).
+- [ ] Make sure you are following our [CONTRIBUTING guidelines](https://github.com/OpenBB-finance/OpenBB/blob/main/CONTRIBUTING.md).
+- [ ] If a feature was added make sure to add it to the corresponding [integration test script](https://github.com/OpenBB-finance/OpenBB/tree/develop/openbb_terminal/miscellaneous/integration_tests_scripts).

.github/labeler.yml

@@ -0,0 +1,27 @@
+version: 2
+appendOnly: true
+labels:
+  - label: "platform"
+    files:
+      - "openbb_platform/.*"
+
+  - label: "v4"
+    files:
+      - "openbb_platform/.*"
+
+  - label: "enhancement"
+    branch: "^feature/.*"
+
+  - label: "bug"
+    branch: "^hotfix/.*"
+
+  - label: "bug"
+    branch: "^bugfix/.*"
+
+  - label: "excel"
+    files:
+      - "website/content/excel/.*"
+
+  - label: "breaking_change"
+    files:
+      - "openbb_platform/core/openbb_core/provider/standard_models/.*"

.github/platform-drafter.yml

@@ -0,0 +1,48 @@
+name-template: 'OpenBB Platform v$NEXT_MINOR_VERSION'
+tag-template: 'v$NEXT_MINOR_VERSION'
+categories:
+  - title: 🦋 OpenBB Platform Enhancements
+    labels:
+      - 'platform'
+      - 'v4'
+  - title: 🐛 OpenBB Platform Bug Fixes
+    labels:
+      - 'bug'
+  - title: 📚 OpenBB Documentation Changes
+    labels:
+      - 'docs'
+include-labels:
+  - 'platform'
+  - 'v4'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&'
+exclude-contributors:
+  - 'jmaslek'
+  - 'DidierRLopes'
+  - 'deeleeramone'
+  - 'hjoaquim'
+  - 'jose-donato'
+  - 'luqmanbello'
+  - 'montezdesousa'
+  - 'tehcoderer'
+  - 'colin99d'
+  - 'piiq'
+  - 'andrewkenreich'
+  - 'IgorWounds'
+  - 'minhhoang1023'
+
+template: |
+  ## Thank you and welcome to our new contributors 🔥
+  $CONTRIBUTORS
+
+  ## What's new 🎉
+
+  ## What's changed 🚀
+  $CHANGES
+
+  We are proud of our community contributors and staunch supporters of open-source ecosystems.
+  Help us promote our community by tagging `@openbb_finance` on X with a link to your pull request,
+  and join our Discord server to chat about your contribution! We want to hear about your experience!
+
+  ### Links 🦋
+  [Website](https://openbb.co/), [Twitter](https://twitter.com/openbb_finance), [Linkedin](https://www.linkedin.com/company/openbb-finance), [Instagram](https://www.instagram.com/openbb.finance/), [Reddit](https://www.reddit.com/r/openbb/), [Discord](https://discord.com/invite/xPHTuHCmuV)

.github/pull_request_template.md

@@ -0,0 +1,7 @@
+# Pull Request OpenBB
+
+Please go to the `Preview` tab and select the appropriate PR sub-template:
+
+* [OpenBB Platform](?expand=1&template=platform_pull_request_template.md)
+* [OpenBB Platform CLI](?expand=1&template=terminal_pull_request_template.md)
+* [OpenBB Developers](?expand=1&template=obb_developer_pull_request_template.md)

.github/release-drafter.yml

@@ -0,0 +1,48 @@
+name-template: 'OpenBB Platform v$NEXT_MINOR_VERSION'
+tag-template: 'v$NEXT_MINOR_VERSION'
+categories:
+  - title: 🚨 OpenBB Platform Breaking Changes
+    labels:
+      - 'breaking_change'
+  - title: 🦋 OpenBB Platform Enhancements
+    labels:
+      - 'platform'
+      - 'v4'
+  - title: 🐛 OpenBB Platform Bug Fixes
+    labels:
+      - 'bug'
+  - title: 📚 OpenBB Documentation Changes
+    labels:
+      - 'docs'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&'
+exclude-contributors:
+  - 'jmaslek'
+  - 'DidierRLopes'
+  - 'deeleeramone'
+  - 'hjoaquim'
+  - 'jose-donato'
+  - 'luqmanbello'
+  - 'montezdesousa'
+  - 'tehcoderer'
+  - 'colin99d'
+  - 'piiq'
+  - 'andrewkenreich'
+  - 'IgorWounds'
+  - 'minhhoang1023'
+
+template: |
+  ## Thank you and welcome to our new contributors 🔥
+  $CONTRIBUTORS
+
+  ## Summary 🎉
+
+  ## What's changed 🚀
+  $CHANGES
+
+  We are proud of our community contributors and staunch supporters of open-source ecosystems.
+  Help us promote our community by tagging `@openbb_finance` on X with a link to your pull request,
+  and join our Discord server to chat about your contribution! We want to hear about your experience!
+
+  ### Links 🦋
+  [Website](https://openbb.co/), [Twitter](https://twitter.com/openbb_finance), [Linkedin](https://www.linkedin.com/company/openbb-finance), [Instagram](https://www.instagram.com/openbb.finance/), [Reddit](https://www.reddit.com/r/openbb/), [Discord](https://discord.com/invite/xPHTuHCmuV)

.github/scripts/noxfile.py

@@ -0,0 +1,47 @@
+"""Nox sessions."""
+
+from pathlib import Path
+
+import nox
+
+ROOT_DIR = Path(__file__).parent.parent.parent
+PLATFORM_DIR = ROOT_DIR / "openbb_platform"
+PLATFORM_TESTS = [
+    str(PLATFORM_DIR / p) for p in ["tests", "core", "providers", "extensions"]
+]
+CLI_DIR = ROOT_DIR / "cli"
+CLI_TESTS = CLI_DIR / "tests"
+
+
+@nox.session(python=["3.9", "3.10", "3.11", "3.12"])
+def unit_test_platform(session):
+    """Run the test suite."""
+    session.install("poetry", "toml")
+    session.run(
+        "python",
+        str(PLATFORM_DIR / "dev_install.py"),
+        "-e",
+        "all",
+        external=True,
+    )
+    session.install("pytest")
+    session.install("pytest-cov")
+    session.run(
+        "pytest", *PLATFORM_TESTS, f"--cov={PLATFORM_DIR}", "-m", "not integration"
+    )
+
+
+@nox.session(python=["3.9", "3.10", "3.11", "3.12"])
+def unit_test_cli(session):
+    """Run the test suite."""
+    session.install("poetry", "toml")
+    session.run(
+        "python",
+        str(PLATFORM_DIR / "dev_install.py"),
+        "-e",
+        "all",
+        external=True,
+    )
+    session.install("pytest")
+    session.install("pytest-cov")
+    session.run("pytest", CLI_TESTS, f"--cov={CLI_DIR}")

.github/scripts/process_changelog.py

@@ -0,0 +1,82 @@
+# process_changelog.py
+import logging
+import re
+import sys
+
+# Set up basic configuration for logging
+logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
+
+
+def process_changelog(file_path, release_pr_number):
+    # Attempt to open and read the file content
+    try:
+        with open(file_path) as file:  # Default mode is 'r' for read
+            lines = file.readlines()
+    except OSError as e:  # Catching file I/O errors
+        logging.error(f"Failed to open or read file: {e}")
+        return
+
+    pr_occurrences = {}  # Dictionary to track occurrences of PR numbers
+
+    # Iterate through each line to find PR numbers
+    for i, line in enumerate(lines):
+        match = re.search(r"\(#(\d+)\)", line)  # Regex to find PR numbers
+        if match:
+            pr_number = int(match.group(1))
+            # Add line index to the list of occurrences for the PR number
+            if pr_number not in pr_occurrences:
+                pr_occurrences[pr_number] = []
+            pr_occurrences[pr_number].append(i)
+
+    # Set of indices to remove: includes all but last occurrence of each PR number
+    to_remove = {
+        i
+        for pr, indices in pr_occurrences.items()
+        if len(indices) > 1
+        for i in indices[:-1]
+    }
+    # Also remove any PR entries less than or equal to the specified release PR number
+    to_remove.update(
+        i
+        for pr, indices in pr_occurrences.items()
+        for i in indices
+        if pr <= release_pr_number
+    )
+
+    # Filter out lines marked for removal
+    processed_lines = [line for i, line in enumerate(lines) if i not in to_remove]
+
+    # Final sweep: Ensure no missed duplicates, keeping only the last occurrence
+    final_lines = []
+    seen_pr_numbers = set()  # Track seen PR numbers to identify duplicates
+    for line in reversed(
+        processed_lines
+    ):  # Start from the end to keep the last occurrence
+        match = re.search(r"\(#(\d+)\)", line)
+        if match:
+            pr_number = int(match.group(1))
+            if pr_number in seen_pr_numbers:
+                continue  # Skip duplicate entries
+            seen_pr_numbers.add(pr_number)
+        final_lines.append(line)
+    final_lines.reverse()  # Restore original order
+
+    # Write the processed lines back to the file
+    try:
+        with open(file_path, "w") as file:
+            file.writelines(final_lines)
+    except OSError as e:  # Handling potential write errors
+        logging.error(f"Failed to write to file: {e}")
+
+
+if __name__ == "__main__":
+    # Ensure correct command line arguments
+    if len(sys.argv) < 3:
+        logging.error(
+            "Usage: python process_changelog.py <changelog_file> <release_pr_number>"
+        )
+        sys.exit(1)
+
+    file_path = sys.argv[1]
+    release_pr_number = int(sys.argv[2])
+    process_changelog(file_path, release_pr_number)

.github/scripts/summarize_changelog.py

@@ -0,0 +1,166 @@
+"""Changelog v2 summary generator."""
+
+import logging
+import re
+import sys
+from typing import Dict
+
+import requests
+
+
+def fetch_pr_details(owner: str, repo: str, pr_number: str, github_token: str) -> dict:
+    """Fetch details of a specific PR from GitHub."""
+    url = f"https://api.github.com/repos/{owner}/{repo}/pulls/{pr_number}"
+    headers = {"Authorization": f"token {github_token}"}
+    response = requests.get(url, headers=headers, timeout=10)
+    if response.status_code == 200:
+        return response.json()
+
+    logging.error(
+        "Failed to fetch PR details for PR #%s. Status code: %s",
+        pr_number,
+        response.status_code,
+    )
+    return {}
+
+
+def parse_and_fetch_pr_details(
+    markdown_text: str, owner: str, repo: str, github_token: str
+) -> Dict[str, str]:
+    """Parse the markdown text and fetch details of PRs mentioned in the text."""
+    sections = re.split(r"\n## ", markdown_text)
+    categories: Dict[str, str] = {}
+
+    for section in sections:
+        split_section = section.split("\n", 1)
+        if len(split_section) < 2:
+            continue
+
+        category_name = split_section[0].strip()
+        items_text = split_section[1].strip()
+        items = re.findall(r"- (?:\[.*?\] - )?(.*?) @.*? \(#(\d+)\)", items_text)
+
+        for _, pr_number in items:
+            pr_details = fetch_pr_details(owner, repo, pr_number, github_token)
+            if pr_details:
+                try:
+                    pr_info = {
+                        "title": pr_details["title"],
+                        "body": re.sub(r"\s+", " ", pr_details["body"].strip()).strip(),
+                    }
+                except Exception as e:
+                    logging.error(
+                        "Failed to fetch PR details for PR #%s: %s", pr_number, e
+                    )
+                if category_name in categories:
+                    categories[category_name].append(pr_info)  # type: ignore
+                else:
+                    categories[category_name] = [pr_info]  # type: ignore
+
+    return categories
+
+
+def insert_summary_into_markdown(
+    markdown_text: str, category_name: str, summary: str
+) -> str:
+    """Insert a summary into the markdown text directly under the specified category name."""
+    marker = f"## {category_name}"
+    if marker in markdown_text:
+        # Find the position right after the category name
+        start_pos = markdown_text.find(marker) + len(marker)
+        # Find the position of the first newline after the category name to ensure we insert before any content
+        newline_pos = markdown_text.find("\n", start_pos)
+        if newline_pos != -1:
+            # Insert the summary right after the newline that follows the category name
+            # Ensuring it's on a new line and followed by two newlines before any subsequent content
+            updated_markdown = (
+                markdown_text[: newline_pos + 1]
+                + "\n"
+                + summary
+                + markdown_text[newline_pos + 1 :]
+            )
+        else:
+            # If there's no newline (e.g., end of file), just append the summary
+            updated_markdown = markdown_text + "\n\n" + summary + "\n"
+        return updated_markdown
+
+    logging.error("Category '%s' not found in markdown.", category_name)
+    return markdown_text
+
+
+def summarize_text_with_openai(text: str, openai_api_key: str) -> str:
+    """Summarize text using OpenAI's GPT model."""
+    from openai import OpenAI  # pylint: disable=C0415
+
+    openai = OpenAI(api_key=openai_api_key)
+    response = openai.chat.completions.create(
+        model="gpt-4",  # noqa: E501
+        messages=[
+            {
+                "role": "system",
+                "content": "Summarize the following text in a concise way to describe what happened in the new release. This will be used on top of the changelog to provide a high-level overview of the changes. Make sure it is well-written, concise, structured and that it captures the essence of the text. It should read like a concise story.",  # noqa: E501 # pylint: disable=C0301
+            },
+            {"role": "user", "content": text},
+        ],
+    )
+    return response.choices[0].message.content  # type: ignore
+
+
+def summarize_changelog_v2(
+    github_token: str,
+    openai_api_key: str,
+    owner: str = "OpenBB-finance",
+    repo: str = "OpenBBTerminal",
+    changelog_v2: str = "CHANGELOG.md",
+) -> None:
+    """Summarize the Changelog v2 markdown text with PR details."""
+    try:
+        with open(changelog_v2) as file:
+            logging.info("Reading file: %s", changelog_v2)
+            data = file.read()
+    except OSError as e:
+        logging.error("Failed to open or read file: %s", e)
+        return
+
+    logging.info("Parsing and fetching PR details...")
+    categories = parse_and_fetch_pr_details(data, owner, repo, github_token)
+
+    categories_of_interest = [
+        "🚨 OpenBB Platform Breaking Changes",
+        "🦋 OpenBB Platform Enhancements",
+        "🐛 OpenBB Platform Bug Fixes",
+        "📚 OpenBB Documentation Changes",
+    ]
+    updated_markdown = data
+
+    logging.info("Summarizing text with OpenAI...")
+    for category_of_interest in categories_of_interest:
+        if category_of_interest in categories:
+            pattern = r"\[.*?\]\(.*?\)|[*_`]"
+            aggregated_text = "\n".join(
+                [
+                    f"- {pr['title']}: {re.sub(pattern, '', pr['body'])}"  # type: ignore
+                    for pr in categories[category_of_interest]  # type: ignore
+                ]
+            )
+            summary = summarize_text_with_openai(aggregated_text, openai_api_key)
+            updated_markdown = insert_summary_into_markdown(
+                updated_markdown, category_of_interest, summary
+            )
+
+    with open(changelog_v2, "w") as file:
+        logging.info("Writing updated file: %s", changelog_v2)
+        file.write(updated_markdown)
+
+
+if __name__ == "__main__":
+    if len(sys.argv) < 3:
+        logging.error(
+            "Usage: python summarize_changelog.py <github_token> <openai_api_key>"
+        )
+        sys.exit(1)
+
+    token = sys.argv[1]
+    openai_key = sys.argv[2]
+
+    summarize_changelog_v2(github_token=token, openai_api_key=openai_key)

.github/workflows/README.md

@@ -0,0 +1,100 @@
+# OpenBB Workflows
+
+This directory contains the workflows for the OpenBB 🦋 Project. The workflows are:
+
+## 📑 Deploy to GitHub Pages
+
+This GitHub Actions workflow is responsible for building the documentation and deploying it to GitHub Pages. This workflow is triggered when a new change is pushed to the `main` or `release` branch of the repository, and the documentation is published to GitHub Pages.
+
+## Branch Name Check
+
+Objective: To check if pull request branch names follow the GitFlow naming convention before merging.
+
+Triggered by: A pull request event where the target branch is either develop or main.
+
+Branches checked: The source branch of a pull request and the target branch of a pull request.
+
+Steps:
+
+1. Extract branch names: Using the jq tool, the source and target branch names are extracted from the pull request event. The branch names are then stored in environment variables and printed as output.
+
+2. Show Output result for source-branch and target-branch: The source and target branch names are printed to the console.
+
+3. Check branch name for develop PRs: If the target branch is develop, then the source branch is checked against a regular expression to ensure that it follows the GitFlow naming convention. If the branch name is invalid, a message is printed to the console and the workflow exits with a status code of 1.
+
+4. Check branch name for main PRs: If the target branch is main, then the source branch is checked against a regular expression to ensure that it is either a hotfix or a release branch. If the branch name is invalid, a message is printed to the console and the workflow exits with a status code of 1.
+
+Note: The GitFlow naming convention for branches is as follows:
+
+- Feature branches: feature/<feature-name>
+- Hotfix branches: hotfix/<hotfix-name>
+- Release branches: release/<major.minor.patch>(rc<number>)
+
+## Deploy to PyPI - Nightly
+
+This workflow is used to publish the latest version of the OpenBB Platform CLI to PyPI. The workflow is triggered at UTC+0 daily by the GitHub Action schedule event.
+
+It does this by first updating the `pyproject.toml` file with a pre-determined version string of the form `<currentVersion>.dev<date>`, where `<date>` represents the current day's date as a 8 digit number.
+
+Then, the code installs `pypa/build` and uses `python -m build` to create a binary wheel and a source tarball in the `dist/` directory.
+
+Finally, it uses the PyPA specific action `gh-action-pypi-publish` to publish the created files to PyPI.
+
+## Deploy the OpenBB Platform to Test PyPI
+
+The Github Action code `Deploy to PyPI` is used to deploy a Python project to PyPI (Python Package Index) and TestPyPI, which is a separate package index for testing purposes. The code is triggered on two events:
+
+1. Push event: The code is triggered whenever there is a push to the `release/*` and `main` branches.
+
+2. Workflow dispatch event: The code can be manually triggered by the workflow dispatch event.
+
+The code sets the concurrency to the `group` and the option `cancel-in-progress` is set to `true` to ensure that the running jobs in the same `group` are cancelled in case another job is triggered.
+
+The code contains two jobs, `deploy-test-pypi` and `deploy-pypi`, both of which have the same steps with slight variations.
+
+The `deploy-test-pypi` job is triggered only if the pushed branch starts with `refs/heads/release/`. This job sets up the Python environment, installs the `build` package using `pip`, builds binary wheel and source tarball using `build`, and finally, publishes the distributions to TestPyPI using the `pypa/gh-action-pypi-publish@release/v1` Github Action. The `password` to access TestPyPI is stored as a secret named `TEST_PYPI_API_TOKEN`.
+
+Similarly, the `deploy-pypi` job is triggered only if the pushed branch starts with `refs/heads/main`. This job follows the same steps as `deploy-test-pypi`, but the distributions are published to PyPI instead of TestPyPI. The `password` to access PyPI is stored as a secret named `PYPI_API_TOKEN`.
+
+Note: The code uses the `pypa/build` package for building the binary wheel and source tarball, and the `pypa/gh-action-pypi-publish@release/v1` Github Action for publishing the distributions to PyPI and TestPyPI.
+
+## Draft release
+
+This GitHub Actions workflow is designed to automatically generate and update draft releases in a GitHub repository. The workflow is triggered when it is manually dispatched, allowing you to control when the draft releases are updated.
+
+## 🧹 General Linting
+
+This GitHub Actions workflow is responsible for running linting checks on the codebase. This workflow is triggered on pull request events such as `opened`, `synchronize`, and `edited`, and push events on branches with names that start with `feature/`, `hotfix/`, or `release/`. The workflow also sets a number of environment variables and uses Github Actions caching to improve performance.
+
+It consists of two jobs: `code-linting` and `markdown-link-check`.
+
+The first job, `code-linting`, runs on an Ubuntu machine and performs several linting tasks on the code in the repository, including:
+
+- Checking out the code from the repository
+- Setting up Python 3.10
+- Installing a number of Python packages necessary for the linting tasks
+- Running `bandit` to check for security vulnerabilities
+- Running `black` to check the code formatting
+- Running `codespell` to check the spelling of comments, strings, and variable names
+- Running `ruff` to check the use of Python
+- Running `pylint` to perform static analysis of the code
+- Running `mypy` to check the type annotations
+- Running `pydocstyle` to check the docstrings
+
+The second job, `markdown-link-check`, runs on an Ubuntu machine and performs linting of the markdown files in the repository. It uses a Docker container `avtodev/markdown-lint` to perform the linting.
+
+## 🏷️ Pull Request Labels
+
+Automatic labelling of pull requests.
+
+## 🚉 Integration test Platform (API)
+
+Run `openbb_platform` API integration tests,
+
+## 🖥️ Unit test CLI
+
+Run `cli` directory unit tests.
+
+## 🚉 Unit test Platform
+
+Run `openbb_platform` directory unit tests - providers, extensions, etc.

.github/workflows/deploy-pypi-nightly.yml

@@ -0,0 +1,41 @@
+name: Deploy to PyPI - Nightly
+
+on: workflow_dispatch
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  deploy-nightly-pypi:
+    name: Build and publish nightly distributions 📦 to PyPI
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+
+      - name: OpenBB Platform - Update version in pyproject.toml and Edit docs
+        run: |
+          sed -i 's/name = ".*"/name = "openbb-nightly"/' openbb_platform/pyproject.toml
+          sed -i "3s/version = \"\(.*\)\"/version = \"\1.dev$(date +%Y%m%d%H%M)\"/" openbb_platform/pyproject.toml
+
+      - name: OpenBB Platform - Create the dynamically generated wheel
+        run: |
+          python -m pip install poetry toml
+          python build/pypi/openbb_platform/nightly.py
+
+      - name: OpenBB Platform - Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: openbb_platform/dist/
+          password: ${{ secrets.NIGHTLY_PYPI_API_TOKEN }}

.github/workflows/deploy-test-pypi.yml

@@ -0,0 +1,68 @@
+name: Deploy the OpenBB Platform to Test PyPI
+
+on:
+  push:
+    branches:
+      - feature/v4-pypi
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  deploy-test-pypi:
+    name: Build and publish 📦 to TestPyPI
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+          --user
+
+      - name: OpenBBTerminal - Update version in pyproject.toml and Edit docs
+        run: |
+          sed -i 's/name = ".*"/name = "openbb-terminal-nightly"/' pyproject.toml
+          sed -i "3s/version = \"\(.*\)\"/version = \"\1.dev$(date +%Y%m%d%H%M)\"/" pyproject.toml
+          sed -i 's|pip install openbb-terminal|pip install openbb-terminal-nightly|g' ./website/pypi.md
+
+      - name: OpenBBTerminal - Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+          .
+
+      - name: OpenBBTerminal - Publish distribution 📦 to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+          password: ${{ secrets.TEST_PYPI_API_TOKEN_OBB_TERMINAL_NIGHTLY }}
+          repository-url: https://test.pypi.org/legacy/
+
+      - name: OpenBB Platform - Update version in pyproject.toml and Edit docs
+        run: |
+          sed -i 's/name = ".*"/name = "openbb-nightly"/' openbb_platform/pyproject.toml
+          sed -i "3s/version = \"\(.*\)\"/version = \"\1.dev$(date +%Y%m%d%H%M)\"/" openbb_platform/pyproject.toml
+
+      - name: OpenBB Platform - Create the dynamically generated wheel
+        run: |
+          python -m pip install poetry toml
+          python build/pypi/openbb_platform/nightly.py
+
+      - name: OpenBB Platform - Publish distribution 📦 to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: openbb_platform/dist/
+          password: ${{ secrets.TEST_PYPI_API_TOKEN_OBB_PLATFORM_NIGHTLY }}
+          repository-url: https://test.pypi.org/legacy/

.github/workflows/draft-release.yml

@@ -0,0 +1,51 @@
+name: 📝 Draft release changelog
+
+on:
+  workflow_dispatch:
+    inputs:
+      release_pr_number:
+        description: "Previous Release PR Number"
+        required: true
+        default: ""
+      tag:
+        description: "Tag for release (manual input)"
+        required: true
+        default: ""
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📟 Checkout code
+        uses: actions/checkout@v4
+
+      - name: 📝 Release Drafter
+        id: release-drafter
+        uses: release-drafter/release-drafter@v6.0.0
+        # with:
+        #   config-name: platform-drafter.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: 💾 Save Changelog
+        run: |
+          cat << 'EOF' > CHANGELOG.md
+          ${{ steps.release-drafter.outputs.body }}
+          EOF
+
+      - name: 🧬 Process Changelog
+        run: |
+          pip install requests openai
+          python .github/scripts/process_changelog.py CHANGELOG.md ${{ github.event.inputs.release_pr_number }}
+          python .github/scripts/summarize_changelog.py ${{ secrets.GITHUB_TOKEN }} ${{ secrets.OPENAI_API_KEY }}
+          cat CHANGELOG.md
+
+      - name: 🛫 Create Release
+        uses: mikepenz/action-gh-release@v1
+        with:
+          body_path: "CHANGELOG.md"
+          tag_name: ${{ github.event.inputs.tag }}
+          prerelease: false
+          draft: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/general-linting.yml

@@ -0,0 +1,96 @@
+name: 🧹 General Linting
+
+env:
+  PIP_DEFAULT_TIMEOUT: 100
+
+on:
+  pull_request:
+    types: [opened, synchronize, edited]
+  # push:
+  #   branches:
+  #     - "feature/*"
+  #     - "hotfix/*"
+  #     - "release/*"
+  merge_group:
+    types: [checks_requested]
+
+# Cancel previous runs that are not yet completed.
+concurrency:
+  group: ${{ github.event_name }}-${{ github.repository }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  code-linting:
+    name: General Code Linting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4.1.1 # actions/checkout v3.0.2
+        with:
+          ref: ${{ github.event.pull_request.head.ref || github.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
+          fetch-depth: 20
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Fetch base branch
+        run: git fetch --no-tags --depth=20 origin ${{ github.base_ref }}
+
+      - name: Setup Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+          architecture: x64
+
+      - name: Get changed files in openbb_platform for PR
+        if: github.event_name == 'pull_request'
+        run: |
+          # "Checking PR diff"
+          echo "diff_files=$(git diff --diff-filter=d --name-only origin/${{ github.base_ref }}...${{ github.head_ref }} | grep -E '^(openbb_platform|cli)/.*\.py$' | grep -v 'openbb_platform/openbb/package' | grep -v 'integration' | grep -v 'tests' | xargs)" >> $GITHUB_ENV
+          echo $diff_files
+
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-linting-${{ hashFiles('**/poetry.lock') }}
+          restore-keys: ${{ runner.os }}-linting-${{ hashFiles('**/poetry.lock') }}
+
+      - run: |
+          pip install openbb-devtools
+          pip install types-pytz types-requests types-termcolor types-tabulate types-PyYAML types-python-dateutil types-setuptools types-six
+      - run: bandit -x ./tests -r . || true
+      - run: codespell --ignore-words=.codespell.ignore --skip="$(tr '\n' ',' < .codespell.skip | sed 's/,$//')" --quiet-level=2
+      - run: |
+          # Run linters for openbb_platform | cli
+          if [ -n "${{ env.diff_files }}" ]; then
+            black --diff --check ${{ env.diff_files }}
+            mypy ${{ env.diff_files }}  --ignore-missing-imports  --scripts-are-modules --check-untyped-defs
+            pydocstyle ${{ env.diff_files }}
+            pylint ${{ env.diff_files }}
+            ruff check ${{ env.diff_files }}
+          else
+            echo "No Python files changed in openbb_platform | cli"
+          fi
+
+  markdown-link-check:
+    name: Markdown Linting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        name: Check out the code
+      - name: Lint Code Base
+        uses: docker://avtodev/markdown-lint:v1
+        with:
+          args: "./*.md ./changelogs/*.md ./openbb_terminal/**/*.md ./discordbot/**/*.md"
+
+  json-yaml-validate:
+    name: JSON Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: json-yaml-validate
+        id: json-yaml-validate
+        uses: GrantBirki/json-yaml-validate@v2.0.0
+        with:
+          yaml_exclude_regex: "construct.yaml"
+          use_gitignore: false

.github/workflows/gh-branch-name-check.yml

@@ -0,0 +1,71 @@
+name: Branch Name Check
+
+on:
+  pull_request:
+    branches:
+      - develop
+      - main
+    types: [opened, synchronize, edited]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check-branch-name:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Get branch names.
+        id: branch-names
+        uses: tj-actions/branch-names@v8
+
+      - name: Show Output result for source-branch and target-branch
+        run: |
+          echo "source-branch=${{ steps.branch-names.outputs.head_ref_branch }}"
+          echo "target-branch=${{ steps.branch-names.outputs.base_ref_branch }}"
+
+      - name: Check branch name for develop PRs
+        id: check-develop-branch
+        if: ${{ steps.branch-names.outputs.base_ref_branch == 'develop' && !github.event.pull_request.head.repo.fork }}
+        run: |
+          if ! [[ "${{ steps.branch-names.outputs.head_ref_branch }}" =~ ^(feature/.*|docs/.*|bugfix/.*|hotfix/.*|release/([a-zA-Z-]+-)?[0-9]+\.[0-9]+\.[0-9]+(rc[0-9]+)?)$ ]]; then
+            echo "reason=Invalid branch name for a Pull Request to be merged to `${{ steps.branch-names.outputs.base_ref_branch }}` branch. Branches must follow the GitFlow naming convention." >> $GITHUB_OUTPUT
+          fi
+
+      - name: Check branch name for main PRs
+        id: check-main-branch
+        if: ${{ steps.branch-names.outputs.base_ref_branch == 'main' }}
+        run: |
+          if ! [[ "${{ steps.branch-names.outputs.head_ref_branch }}" =~ ^(hotfix/.*|docs/.*|release/([a-zA-Z-]+-)?[0-9]+\.[0-9]+\.[0-9]+(rc[0-9]+)?)$ ]]; then
+            echo "reason=Invalid branch name for a Pull Request to be merged to `${{ steps.branch-names.outputs.base_ref_branch }}` branch. Pull requests must be from a hotfix or release branch." >> $GITHUB_OUTPUT
+          fi
+
+      - name: Check for existing comment
+        if: ${{ steps.check-develop-branch.outputs.reason || steps.check-main-branch.outputs.reason }}
+        id: check-comment
+        run: |
+          commentExists=$(gh pr view ${{ github.event.pull_request.number }} --json comments -q '.comments[].body' | grep -F "Invalid branch name" || echo '')
+          if [[ -n "$commentExists" ]]; then
+            echo "commentExists=true" >> $GITHUB_OUTPUT
+          else
+            echo "commentExists=false" >> $GITHUB_OUTPUT
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Comment on PR for invalid branch name
+        if: steps.check-comment.outputs.commentExists == 'false'
+        run: |
+          reason="${{ steps.check-develop-branch.outputs.reason }}${{ steps.check-main-branch.outputs.reason }}"
+          gh pr comment ${{ github.event.pull_request.number }} --body "$reason Please review our [branch naming guidelines](https://docs.openbb.co/platform/developer_guide/github#branch-naming-conventions)."
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Fail if branch name is invalid
+        if: ${{ steps.check-develop-branch.outputs.reason || steps.check-main-branch.outputs.reason }}
+        run: |
+          echo "Invalid branch name. Please review our branch naming guidelines."
+          exit 1

.github/workflows/gh-pr-labels.yml

@@ -0,0 +1,25 @@
+name: 🏷️ Pull Request Labels
+
+on:
+  pull_request:
+    types: [opened, reopened, labeled, unlabeled, synchronize]
+
+jobs:
+  label:
+    runs-on: ubuntu-latest
+    steps:
+      # - uses: mheap/github-action-required-labels@v1
+      #   with:
+      #     mode: minimum
+      #     count: 1
+      #     labels: "guides, bug, build, docker, docs, feat XS, feat S, feat M, feat L, feat XL, help wanted, refactor, tests, dependencies, release"
+      - uses: mheap/github-action-required-labels@v1
+        with:
+          mode: exactly
+          count: 0
+          labels: "do not merge"
+
+      - name: 🏷️ Label OpenBB Platform PRs
+        uses: srvaroa/labeler@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/macos-build.yml

@@ -0,0 +1,218 @@
+name: MacOS Build
+
+env:
+  OPENBB_LOG_COLLECT: false
+  OPENBB_USE_PROMPT_TOOLKIT: false
+  OPENBB_FILE_OVERWRITE: true
+  PIP_DEFAULT_TIMEOUT: 100
+  PYTHONNOUSERSITE: 1
+
+on: workflow_dispatch
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  M1-MacOs-Build:
+    name: M1 MacOS Build
+    runs-on: [self-hosted, macos, ARM64]
+    steps:
+      # Checkout repository main branch. this allows for the commit hashes to line up
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Git Log
+        run: git log
+      # The following commands to clear previous PATHS and restore to defaults since we have to maintain the instance ourselves
+      - name: Clean Previous Path
+        run: |
+          export PATH=""
+          export PATH="/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"
+          echo $PATH
+      # Set up caching for conda env so that the workflow runs quickly after the first time
+      - name: Setup Conda Caching
+        uses: actions/cache@v3
+        with:
+          path: ~/conda_pkgs_dir
+          key: conda-macos-3-10-${{ hashFiles('build/conda/environments/constructor.yml') }}
+      # Set up miniconda using the environment yaml file within the repo
+      - name: Setup Miniconda
+        uses: conda-incubator/setup-miniconda@v3.0.4
+        with:
+          miniconda-version: "latest"
+          auto-update-conda: true
+          channels: conda-forge,defaults
+          show-channel-urls: true
+          channel-priority: flexible
+          environment-file: build/conda/environments/constructor.yml
+          activate-environment: constructor
+          auto-activate-base: false
+
+      - name: Creating Application Keychain
+        env:
+          MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
+          MACOS_CERTIFICATE_PWD: ${{ secrets.MACOS_CERTIFICATE_PWD }}
+          MACOS_KEYCHAIN_PWD: ${{ secrets.MACOS_KEYCHAIN_PWD }}
+          MACOS_CODESIGN_IDENTITY: ${{ secrets.MACOS_CODESIGN_IDENTITY }}
+        run:
+          | # when pushing to main, make to generate new cert, and utilize secrets to store new password, and identity
+          echo "Ensuring Keychain with same name does not exist"
+          rm -rf /Users/openbb/Library/Keychains/build.keychain-db
+          echo "Decoding certificate"
+          echo $MACOS_CERTIFICATE | base64 --decode > certificate.p12
+          echo "Creating Keychain"
+          security create-keychain -p $MACOS_KEYCHAIN_PWD build.keychain
+          echo "Setting Default Keychain"
+          security default-keychain -s build.keychain
+          echo "Unlocking Keychain"
+          security unlock-keychain -p $MACOS_KEYCHAIN_PWD build.keychain
+          echo "Importing Keychain"
+          security import certificate.p12 -k build.keychain -P $MACOS_CERTIFICATE_PWD -T /usr/bin/codesign
+          echo "Setting Partition List"
+          security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k $MACOS_KEYCHAIN_PWD build.keychain
+
+      - name: Create Signed Package
+        env:
+          MACOS_INSTALLER_KEYCHAIN_PWD: ${{ secrets.MACOS_INSTALLER_KEYCHAIN_PWD }}
+          MACOS_INSTALLER_SIGNING_IDENTITY_NAME: ${{ secrets.MACOS_CODESIGN_INSTALLER_IDENTITY_NAME }}
+          MACOS_APPLICATION_SIGNING_IDENTITY: ${{ secrets.MACOS_CODESIGN_IDENTITY }}
+        run: |
+          security unlock-keychain -p $MACOS_INSTALLER_KEYCHAIN_PWD install.keychain
+          echo "signing_identity_name: $MACOS_INSTALLER_SIGNING_IDENTITY_NAME" >> build/conda/installer/construct.yaml
+          echo "notarization_identity_name: $MACOS_APPLICATION_SIGNING_IDENTITY" >> build/conda/installer/construct.yaml
+          cd build/conda && constructor installer/. && cd ../../
+          mv build/conda/OpenBB-Platform-MacOSX-arm64.pkg OpenBB-Platform-MacOSX-arm64.pkg
+        shell: bash -l {0}
+
+      - name: Deleting Previous Keychain
+        run: |
+          echo "Deleting Previous Keychain to Clean Instance"
+          rm -rf /Users/openbb/Library/Keychains/build.keychain-db
+
+      - name: Clean up Build Artifacts
+        run: |
+          rm -rf build/conda/tmp
+
+      - name: Notarize DMG
+        env:
+          NOTARIZE_APPLE_ID: ${{ secrets.NOTARIZE_APPLE_ID }}
+          NOTARIZE_APPLE_PWD: ${{ secrets.NOTARIZE_APPLE_PWD }}
+          NOTARIZE_APPLE_TEAM_ID: ${{ secrets.NOTARIZE_APPLE_TEAM_ID }}
+        run: |
+          xcrun notarytool submit OpenBB-Platform-MacOSX-arm64.pkg --apple-id "$NOTARIZE_APPLE_ID" --password "$NOTARIZE_APPLE_PWD" --team-id "$NOTARIZE_APPLE_TEAM_ID" --wait
+
+      - name: Staple
+        run: |
+          xcrun stapler staple OpenBB-Platform-MacOSX-arm64.pkg
+
+      - name: Save Build Artifact PKG
+        uses: actions/upload-artifact@v4
+        with:
+          name: OpenBBM1.pkg
+          path: OpenBB-Platform-MacOSX-arm64.pkg
+
+      - name: Clean up Build Artifacts
+        run: |
+          rm OpenBB-Platform-MacOSX-arm64.pkg
+
+  # Job to build the MacOS Intel version of the Terminal===================================
+  Intel-MacOs-Build:
+    name: Intel MacOS Build
+    runs-on: [self-hosted, macos, x64]
+    steps:
+      # Checkout repository main branch. this allows for the commit hashes to line up
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Git Log
+        run: git log
+      # The following commands to clear previous PATHS and restore to defaults since we have to maintain the instance ourselves
+      - name: Clean Previous Path
+        run: |
+          export PATH=""
+          export PATH="/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"
+          echo $PATH
+      # Set up caching for conda env so that the workflow runs quickly after the first time
+      - name: Setup Conda Caching
+        uses: actions/cache@v3
+        with:
+          path: ~/conda_pkgs_dir
+          key: conda-macos-3-10-${{ hashFiles('build/conda/environments/constructor.yml') }}
+      # Set up miniconda using the environment yaml file within the repo
+      - name: Setup Miniconda
+        uses: conda-incubator/setup-miniconda@v3.0.4
+        with:
+          miniconda-version: "latest"
+          auto-update-conda: true
+          channels: conda-forge,defaults
+          show-channel-urls: true
+          channel-priority: flexible
+          environment-file: build/conda/environments/constructor.yml
+          activate-environment: constructor
+          auto-activate-base: false
+
+      - name: Creating Application Keychain
+        env:
+          MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
+          MACOS_CERTIFICATE_PWD: ${{ secrets.MACOS_CERTIFICATE_PWD }}
+          MACOS_KEYCHAIN_PWD: ${{ secrets.MACOS_KEYCHAIN_PWD }}
+          MACOS_CODESIGN_IDENTITY: ${{ secrets.MACOS_CODESIGN_IDENTITY }}
+        run:
+          | # when pushing to main, make to generate new cert, and utilize secrets to store new password, and identity
+          echo "Ensuring Keychain with same name does not exist"
+          rm -rf /Users/openbb/Library/Keychains/build.keychain-db
+          echo "Decoding certificate"
+          echo $MACOS_CERTIFICATE | base64 --decode > certificate.p12
+          echo "Creating Keychain"
+          security create-keychain -p $MACOS_KEYCHAIN_PWD build.keychain
+          echo "Setting Default Keychain"
+          security default-keychain -s build.keychain
+          echo "Unlocking Keychain"
+          security unlock-keychain -p $MACOS_KEYCHAIN_PWD build.keychain
+          echo "Importing Keychain"
+          security import certificate.p12 -k build.keychain -P $MACOS_CERTIFICATE_PWD -T /usr/bin/codesign
+          echo "Setting Partition List"
+          security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k $MACOS_KEYCHAIN_PWD build.keychain
+
+      - name: Create Signed Package
+        env:
+          MACOS_INSTALLER_KEYCHAIN_PWD: ${{ secrets.MACOS_INSTALLER_KEYCHAIN_PWD }}
+          MACOS_INSTALLER_SIGNING_IDENTITY_NAME: ${{ secrets.MACOS_CODESIGN_INSTALLER_IDENTITY_NAME }}
+          MACOS_APPLICATION_SIGNING_IDENTITY: ${{ secrets.MACOS_CODESIGN_IDENTITY }}
+        run: |
+          security unlock-keychain -p $MACOS_INSTALLER_KEYCHAIN_PWD install.keychain
+          echo "signing_identity_name: $MACOS_INSTALLER_SIGNING_IDENTITY_NAME" >> build/conda/installer/construct.yaml
+          echo "notarization_identity_name: $MACOS_APPLICATION_SIGNING_IDENTITY" >> build/conda/installer/construct.yaml
+          cd build/conda && constructor installer/. && cd ../../
+          mv build/conda/OpenBB-Platform-MacOSX-x86_64.pkg OpenBB-Platform-MacOSX-x86_64.pkg
+        shell: bash -l {0}
+
+      - name: Deleting Previous Keychain
+        run: |
+          echo "Deleting Previous Keychain to Clean Instance"
+          rm -rf /Users/openbb/Library/Keychains/build.keychain-db
+
+      - name: Clean up Build Artifacts
+        run: |
+          rm -rf build/conda/tmp
+
+      - name: Notarize DMG
+        env:
+          NOTARIZE_APPLE_ID: ${{ secrets.NOTARIZE_APPLE_ID }}
+          NOTARIZE_APPLE_PWD: ${{ secrets.NOTARIZE_APPLE_PWD }}
+          NOTARIZE_APPLE_TEAM_ID: ${{ secrets.NOTARIZE_APPLE_TEAM_ID }}
+        run: |
+          xcrun notarytool submit OpenBB-Platform-MacOSX-x86_64.pkg --apple-id "$NOTARIZE_APPLE_ID" --password "$NOTARIZE_APPLE_PWD" --team-id "$NOTARIZE_APPLE_TEAM_ID" --wait
+
+      - name: Staple
+        run: |
+          xcrun stapler staple OpenBB-Platform-MacOSX-x86_64.pkg
+
+      - name: Save Build Artifact PKG
+        uses: actions/upload-artifact@v4
+        with:
+          name: OpenBBIntel.pkg
+          path: OpenBB-Platform-MacOSX-x86_64.pkg
+
+      - name: Clean up Build Artifacts
+        run: |
+          rm OpenBB-Platform-MacOSX-x86_64.pkg

.github/workflows/test-integration-platform.yml

@@ -0,0 +1,115 @@
+name: 🚉 Integration test Platform (API)
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - release/*
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  api-integration-tests:
+    runs-on: ubuntu-latest
+    env:
+      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+      OPENBB_API_AUTH: true
+      OPENBB_API_USERNAME: "USER"
+      OPENBB_API_PASSWORD: "PASS"
+
+    steps:
+      - name: Slack Notification - Starting
+        uses: act10ns/slack@v1
+        with:
+          status: starting
+          channel: "#workflows"
+          message: Starting API Integration Test...
+        if: always()
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Checkout specific ref
+        if: github.event_name == 'pull_request'
+        run: git fetch origin ${{ github.event.pull_request.head.ref }} && git checkout FETCH_HEAD
+
+      - name: Setup Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+          architecture: x64
+
+      - name: Install Dependencies
+        run: |
+          python -m venv runner_env
+          source runner_env/bin/activate
+          pip install poetry toml
+          python openbb_platform/dev_install.py -e
+
+      - name: Populate System Setting Files
+        run: |
+          mkdir -p ~/.openbb_platform
+          touch ~/.openbb_platform/system_settings.json
+          echo '{"log_collect":false}' > ~/.openbb_platform/system_settings.json
+          cat ~/.openbb_platform/system_settings.json
+
+      - name: Create and Populate user_settings.json from GitHub Secrets
+        run: |
+          touch ~/.openbb_platform/user_settings.json
+          echo '{
+            "credentials": {
+              "benzinga_api_key": "${{ secrets.BENZINGA_API_KEY }}",
+              "fmp_api_key": "${{ secrets.FMP_API_KEY }}",
+              "polygon_api_key": "${{ secrets.POLYGON_API_KEY }}",
+              "alpha_vantage_api_key": "${{ secrets.ALPHA_VANTAGE_API_KEY }}",
+              "fred_api_key": "${{ secrets.FRED_API_KEY }}",
+              "intrinio_api_key": "${{ secrets.INTRINIO_API_KEY }}",
+              "tradingeconomics_api_key": "${{ secrets.TRADINGECONOMICS_API_KEY }}",
+              "quandl_api_key": "${{ secrets.QUANDL_API_KEY }}",
+              "biztoc_api_key": "${{ secrets.BIZTOC_API_KEY }}",
+              "nasdaq_api_key": "${{ secrets.NASDAQ_API_KEY }}",
+              "tiingo_token": "${{ secrets.TIINGO_TOKEN }}"
+            }
+          }' > ~/.openbb_platform/user_settings.json
+
+      - name: Build openbb
+        run: |
+          source runner_env/bin/activate
+          python -c "import openbb; openbb.build()"
+
+      - name: Launch the Uvicorn Process
+        run: |
+          source runner_env/bin/activate
+          uvicorn openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload &
+
+      - name: Wait for 42 seconds
+        run: sleep 42
+
+      - name: Check installed packages
+        run: |
+          source runner_env/bin/activate
+          pip list
+
+      - name: Run Integration Tests
+        run: |
+          source runner_env/bin/activate
+          pytest openbb_platform -m integration
+
+      - name: Upload summary to Slack
+        uses: adrey/slack-file-upload-action@master
+        with:
+          token: ${{ secrets.SLACK_API_TOKEN }}
+          initial_comment: "API Integration test summary"
+          title: "Integration test summary"
+          path: summary.txt
+          channel: ${{ secrets.SLACK_CHANNEL_ID }}
+
+      - name: Slack Notification - Success/Failure
+        uses: act10ns/slack@v1
+        with:
+          status: ${{ job.status }}
+          steps: ${{ toJson(steps) }}
+          channel: "#workflows"
+        if: always()

.github/workflows/test-unit-cli.yml

@@ -0,0 +1,46 @@
+name: 🖥️ Unit test CLI
+
+on:
+  pull_request:
+    branches:
+      - develop
+    paths:
+      - 'cli/**'
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+    cancel-in-progress: true
+
+jobs:
+  unit_tests:
+    runs-on: ubuntu-latest
+    strategy:
+        fail-fast: false
+
+        matrix:
+          python_version:
+            ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: Install Python ${{ matrix.python_version }}
+        uses: actions/setup-python@v5
+        with:
+            python-version: ${{ matrix.python_version }}
+            allow-prereleases: true
+            cache: "pip"
+
+      - name: Cache pip packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('cli/poetry.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Run tests
+        run: |
+          pip install nox
+          nox -f .github/scripts/noxfile.py -s unit_test_cli --python ${{ matrix.python_version }}

.github/workflows/test-unit-platform.yml

@@ -0,0 +1,46 @@
+name: 🚉 Unit test Platform
+
+on:
+  pull_request:
+    branches:
+      - develop
+    paths:
+      - 'openbb_platform/**'
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+    cancel-in-progress: true
+
+jobs:
+  unit_tests:
+    runs-on: ubuntu-latest
+    strategy:
+        fail-fast: false
+
+        matrix:
+          python_version:
+            ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: Install Python ${{ matrix.python_version }}
+        uses: actions/setup-python@v5
+        with:
+            python-version: ${{ matrix.python_version }}
+            allow-prereleases: true
+            cache: "pip"
+
+      - name: Cache pip packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('openbb_platform/poetry.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Run tests
+        run: |
+          pip install nox
+          nox -f .github/scripts/noxfile.py -s unit_test_platform --python ${{ matrix.python_version }}