Feature/v4 pypi (#5579)

* improvements to the publish script * move scripts * initial script that builds the package * adjustments on the docs * test pypi workflow * add hour and minute to version * black * ruff * duplicate file * moving files instead * build throught the script instead * update nox file * integration tests workflow * change workflow * fix dev_install * fix in sed cmd * testing the platform only * commenting out the publishing * fix run commands * improvements to the publish script and doc * fix publish script * updating the script and the workflow * feature/v4-pypi nightly (#5589) * init * Update nightly.py * cleanup * init file * not referencing dev_utils * updating obb platform key * revert * Increase warmup time * project name on pyproject and adding the --pre flag on readme * moving to the build folder * fix noxfile * reflecting the moves on the import statements * fix pyproject path * ruff * fix paths * fix super typo * update workflows * moving the pypi terminal files into its folder --------- Co-authored-by: teh_coderer <[email protected]> Co-authored-by: Igor Radovanovic <[email protected]> Co-authored-by: Theodore Aptekarev <[email protected]>
OpenBB-finance · Nov 3, 2023 · 3b8004c · 3b8004c
1 parent 8e6967b
commit 3b8004c
Show file tree

Hide file tree

Showing 17 changed files with 273 additions and 123 deletions.
diff --git a/.github/workflows/platform-api-integration-test.yml b/.github/workflows/platform-api-integration-test.yml
@@ -102,8 +102,8 @@ jobs:
           pip list
           uvicorn openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload &
 
-      - name: Wait for 10 seconds
-        run: sleep 30
+      - name: Wait for 42 seconds
+        run: sleep 42
 
       - name: Run API Integration Tests
         run: |

diff --git a/.github/workflows/pypi-nightly.yml b/.github/workflows/pypi-nightly.yml
@@ -12,37 +12,52 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Setup Python 3.9
-      uses: actions/setup-python@v4
-      with:
-        python-version: "3.9"
-
-    - name: Update version in pyproject.toml and Edit docs
-      run: |
-        sed -i 's/name = ".*"/name = "openbb-nightly"/' pyproject.toml
-        sed -i "3s/version = \"\(.*\)\"/version = \"\1.dev$(date +%Y%m%d)\"/" pyproject.toml
-        head pyproject.toml
-        sed -i 's/pip install openbb/pip install openbb-nightly/g; s/from openbb_terminal.sdk import openbb/from openbb_terminal.sdk import openbb/g' ./website/pypi.md
-
-
-    - name: Install pypa/build
-      run: >-
-        python -m
-        pip install
-        build
-        --user
-
-    - name: Build a binary wheel and a source tarball
-      run: >-
-        python -m
-        build
-        --sdist
-        --wheel
-        --outdir dist/
-        .
-
-    - name: Publish distribution 📦 to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        password: ${{ secrets.NIGHTLY_PYPI_API_TOKEN }}
+      - uses: actions/checkout@v3
+      - name: Setup Python 3.9
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - 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 }}
+
+      - 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 dinamically 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.NIGHTLY_PYPI_API_TOKEN }}
diff --git a/.github/workflows/test_pypi_platform.yml b/.github/workflows/test_pypi_platform.yml
@@ -0,0 +1,68 @@
+name: Deploy the OpenBB Platform and the OpenBBTerminal 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@v3
+      - name: Setup Python 3.9
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - 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 dinamically 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/
diff --git a/openbb_platform/PUBLISH.md → build/pypi/openbb_platform/PUBLISH.md b/openbb_platform/PUBLISH.md → build/pypi/openbb_platform/PUBLISH.md
@@ -7,15 +7,15 @@ Publishing checklist:
 1. Ensure all unit tests pass: `pytest openbb_platform -m "not integration"`
 2. Ensure all integration tests pass: `pytest openbb_platform -m integration`
 3. Change the Platform version on:
-   - `openbb_platform/platform/core/openbb_core/app/constants.py`
+   -  `openbb_platform/platform/core/openbb_core/app/constants.py`
    - `openbb_platform/README.md`
-4. Run the publishing script: `python openbb_platform/dev_utils/dev_publish.py`
-5. Update poetry files: `python openbb_platform/dev_utils/poetry_update.py`
+4. Run the publishing script: `python build/pypi/openbb_platform/publish.py`
+5. Update poetry files: `python build/pypi/openbb_platform/poetry_update.py`
 6. Open a PR so that changes are reflected on the main branch
 7. If applicable, set the version on `constants.py` to use the `dev` tag again
 
 Finally, check if everything works:
 
-1. Install and test the package from Pypi on a clean environment
+1. Install and test the package from Pypi on a clean environment.
 2. Check if all the `pyproject.toml` files are correct, including the `openbb_platform` one.
 3. Double check if there is any new extension or provider that needs to be added to [integration tests GitHub Action workflow](/.github/workflows/platform-api-integration-test.yml).
diff --git a/build/pypi/openbb_platform/nightly.py b/build/pypi/openbb_platform/nightly.py
@@ -0,0 +1,83 @@
+import subprocess
+import sys
+from pathlib import Path
+from typing import Any, Dict
+
+import toml
+
+PLATFORM_PATH = Path(__file__).parent.parent.parent.parent.resolve() / "openbb_platform"
+PYPROJECT = PLATFORM_PATH / "pyproject.toml"
+
+SUB_PACKAGES = {}
+DEPENDENCIES: Dict[str, Any] = {}
+PLUGINS = {"openbb_core_extension": {}, "openbb_provider_extension": {}}
+CMD = [sys.executable, "-m", "poetry", "build"]
+
+
+PYPROJECT_TOML = toml.load(PYPROJECT)
+POETRY_DICT: Dict[str, dict] = PYPROJECT_TOML["tool"]["poetry"]
+POETRY_DICT.pop("extras", None)
+
+
+original_pyproject = PYPROJECT.read_text()
+
+
+def gather_metadata(sub_path: str):
+    """Gather metadata from the pyproject.toml files.
+
+    Parameters
+    ----------
+    sub_path : str
+        The path to the sub packages.
+    """
+    for path in PLATFORM_PATH.rglob(f"{sub_path}/**/pyproject.toml"):
+        pyproject_toml = toml.load(path)
+        poetry_dict: Dict[str, dict] = pyproject_toml["tool"]["poetry"]
+        package_name = poetry_dict["packages"][0]["include"]
+
+        for extension in list(PLUGINS.keys()):
+            PLUGINS[extension].update(poetry_dict.get("plugins", {}).get(extension, {}))
+
+        DEPENDENCIES.update(pyproject_toml["tool"]["poetry"]["dependencies"])
+        SUB_PACKAGES[package_name] = path.relative_to(PLATFORM_PATH).parent.as_posix()
+
+
+def build():
+    """Build the Platform package."""
+    for sub_path in ["platform", "providers", "extensions"]:
+        gather_metadata(sub_path)
+
+    # need to pop these from the dependencies
+    DEPENDENCIES.pop("openbb-core", None)
+    DEPENDENCIES.pop("openbb-provider", None)
+
+    # add the sub packages
+    for package_name, path in SUB_PACKAGES.items():
+        POETRY_DICT["packages"].append({"include": package_name, "from": f"./{path}"})
+
+    # add the plugins extensions
+    for extension, plugins in PLUGINS.items():
+        POETRY_DICT.setdefault("plugins", {}).setdefault(extension, {}).update(plugins)
+
+    # update the dependencies and platform poetry dict
+    POETRY_DICT["dependencies"] = DEPENDENCIES
+    PYPROJECT_TOML["tool"]["poetry"] = POETRY_DICT
+
+    temp_pyproject = toml.dumps(PYPROJECT_TOML)
+
+    try:
+        with open(PYPROJECT, "w", encoding="utf-8", newline="\n") as f:
+            f.write(temp_pyproject)
+
+        subprocess.run(CMD, cwd=PLATFORM_PATH, check=True)  # noqa: S603,PLW1510
+    except (Exception, KeyboardInterrupt) as e:
+        print(e)  # noqa: T201
+        print("Restoring pyproject.toml")  # noqa: T201
+
+    # we restore the original pyproject.toml
+    with open(PYPROJECT, "w", encoding="utf-8", newline="\n") as f:
+        f.write(original_pyproject)
+
+
+if __name__ == "__main__":
+    build()
diff --git a/openbb_platform/poetry_update.py → build/pypi/openbb_platform/poetry_update.py b/openbb_platform/poetry_update.py → build/pypi/openbb_platform/poetry_update.py
@@ -1,27 +1,27 @@
-import os
+import subprocess
 import sys
 from pathlib import Path
 from typing import List, Optional
 
+PLATFORM_PATH = Path(__file__).parent.parent.parent.parent.resolve() / "openbb_platform"
 
 def update_lock_file(packages: Optional[List[str]] = None) -> None:
     """Update the poetry lock files in all the packages or in the given packages."""
-    for path in Path.cwd().rglob("pyproject.toml"):
+    for path in PLATFORM_PATH.rglob("pyproject.toml"):
         if packages and path.parent.name not in packages:
             print(f"Skipping {path.parent.name}")  # noqa: T201
             continue
 
         print(f"\nUpdating lock file in {path.parent.name}")  # noqa: T201
-        os.chdir(path.parent)
-        os.system("poetry lock --no-update")  # noqa: S605, S607
+        CMD = [sys.executable, "-m", "poetry", "lock", "--no-update"]
+        subprocess.run(CMD, cwd=path.parent, check=True)  # noqa: S603,PLW1510
 
-        # Fix line endings and encoding
         lock_file = path.parent / "poetry.lock"
-        lock_file.write_text(
-            lock_file.read_text(),
-            encoding="utf-8",
-            newline="\n",
-        )
+        lock_text = lock_file.read_text()
+
+        # Fix line endings and encoding
+        with open(lock_file, "w", encoding="utf-8", newline="\n") as f:
+            f.write(lock_text)
 
 
 if __name__ == "__main__":

diff --git a/build/pypi/openbb_platform/publish.py b/build/pypi/openbb_platform/publish.py
@@ -0,0 +1,39 @@
+import subprocess
+import sys
+from pathlib import Path
+
+PLATFORM_PATH = Path(__file__).parent.resolve() / "openbb_platform"
+
+SUB_PACKAGES = ["platform/provider", "platform/core", "extensions", "providers"]
+
+CMD = [sys.executable, "-m", "poetry"]
+VERSION_BUMP_CMD = ["version", "prerelease"]
+PUBLISH_CMD = ["publish", "--build"]
+
+
+def run_cmds(directory: Path):
+    """Run the commands for publishing"""
+    print(f"Publishing: {directory.name}")  # noqa: T201
+
+    subprocess.run(CMD + VERSION_BUMP_CMD, cwd=directory, check=True)  # noqa: S603
+    subprocess.run(CMD + PUBLISH_CMD, cwd=directory, check=True)  # noqa: S603
+
+
+def publish():
+    """Publish the Platform to PyPi"""
+    for sub_path in SUB_PACKAGES:
+        for path in PLATFORM_PATH.rglob(f"{sub_path}/**/pyproject.toml"):
+            run_cmds(path.parent)
+
+    # openbb
+    run_cmds(PLATFORM_PATH)
+
+
+if __name__ == "__main__":
+    raise Exception(
+        "If you're ar running this script for the first time,"
+        "ensure you have changed `VERSION` on System Settings "
+        "before you publish the `openbb-core` package to Pypi."
+    )
+
+    publish()
diff --git a/build/pypi/build.sh → build/pypi/openbb_terminal/build.sh b/build/pypi/build.sh → build/pypi/openbb_terminal/build.sh
diff --git a/build/pypi/test_publish.sh → build/pypi/openbb_terminal/test_publish.sh b/build/pypi/test_publish.sh → build/pypi/openbb_terminal/test_publish.sh
diff --git a/noxfile.py b/noxfile.py
@@ -12,7 +12,11 @@
 def tests(session):
     session.install("poetry", "toml")
     session.run(
-        "python", "./openbb_platform/dev_install.py", "-e", "all", external=True
+        "python",
+        "./openbb_platform/dev_install.py",
+        "-e",
+        "all",
+        external=True,
     )
     session.install("pytest")
     session.install("pytest-cov")

diff --git a/openbb_platform/README.md b/openbb_platform/README.md
@@ -6,21 +6,19 @@
 | ![OpenBBLogo](https://user-images.githubusercontent.com/25267873/218899768-1f0964b8-326c-4f35-af6f-ea0946ac970b.png) |
 | Check our website at [openbb.co](www.openbb.co) |
 
-
 ## OpenBB Platform Overview
 
 The OpenBB Platform provides a convenient way to access raw financial data from multiple data providers. The package comes with a ready to use REST API - this allows developers from any language to easily create applications on top of OpenBB Platform.
 
-
 ## Installation
 
 The command below provides access to the core functionalities behind the OpenBB Platform.
 
 ```bash
-pip install openbb==4.0.0a4
+pip install openbb --pre
 ```
 
-> Note that the version `4.0.0a4` is an example and you should replace it with the latest version available.
+> The `--pre` flag is required to install the latest alpha version.
 
 To install extensions that expand the core functionalities specify the extension name or use `all` to install all.
 

diff --git a/openbb_platform/dev_install.py b/openbb_platform/dev_install.py
@@ -76,7 +76,9 @@ def install_local(_extras: bool = False):
 
     try:
         # we create a temporary pyproject.toml
-        PYPROJECT.write_text(TEMP_PYPROJECT)
+        with open(PYPROJECT, "w", encoding="utf-8", newline="\n") as f:
+            f.write(TEMP_PYPROJECT)
+
         CMD = [sys.executable, "-m", "poetry"]
 
         subprocess.run(  # noqa: PLW1510