diff options
author | Henrique Joaquim <henriquecjoaquim@gmail.com> | 2024-05-17 13:51:16 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-05-17 12:51:16 +0000 |
commit | b33e563dc19dcce2aaf382202c557348a98b7c3b (patch) | |
tree | 77c45715a4522f834aa97cd32c04069ea054f366 | |
parent | d903bf80064a266ecf476edea110f8e5674c75ba (diff) |
[Feature] OpenBB Platform DevContainer (#6426)
* devcontainer and its docs
* typo
* remove file
* remove comments from json
-rw-r--r-- | .devcontainer/devcontainer.json | 13 | ||||
-rw-r--r-- | README.md | 14 | ||||
-rw-r--r-- | website/content/platform/installation.md | 11 |
3 files changed, 24 insertions, 14 deletions
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 00000000000..78807d629a5 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,13 @@ +{ + "name": "OpenBB Platform Dev Container", + "image": "mcr.microsoft.com/devcontainers/python:1-3.10-bookworm", + "postCreateCommand": "python3 -m venv obb && . obb/bin/activate && pip install poetry && python3 openbb_platform/dev_install.py --extras --cli", + "customizations": { + "vscode": { + "extensions": [ + "ms-python.python", + "ms-python.vscode-pylance" + ] + } + } +}
\ No newline at end of file diff --git a/README.md b/README.md index 58f7eb3773f..bba11f8a168 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,3 @@ -## Announcement - -OpenBB Terminal v3.2.5 will be the last release made available. - -As we transition our focus to the OpenBB Platform, this repository will soon be rebranded as OpenBB-finance/OpenBBPlatform. - -However, we are committed to continuing our mission to democratize investment research by helping users and contributors with financial data integration and standardization. - -To achieve that, we are working on a new CLI tool built on top of the OpenBB Platform that will soon be available to everyone for free. - -[![GitHub release](https://img.shields.io/github/release/OpenBB-finance/OpenBBTerminal.svg?maxAge=3600)](https://github.com/OpenBB-finance/OpenBBTerminal/releases) - ---- - <br /> <img src="https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/images/platform-light.svg?raw=true#gh-light-mode-only" alt="OpenBB Terminal logo" width="600"> <img src="https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/images/platform-dark.svg?raw=true#gh-dark-mode-only" alt="OpenBB Terminal logo" width="600"> diff --git a/website/content/platform/installation.md b/website/content/platform/installation.md index 9ef0a060ce4..66cae1748b4 100644 --- a/website/content/platform/installation.md +++ b/website/content/platform/installation.md @@ -194,6 +194,17 @@ python dev_install.py To install all extensions and providers, run: `python dev_install.py -e` ::: +### Devcontainer + +The OpenBB Platform can be run in a [Devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) in VS Code. This is a container with a well-defined environment, and it can be used to develop, build, test, and run the OpenBB Platform and its CLI. + +1. Open the project in VS Code +2. Press F1 (Command Palette) and select Remote-Containers: Reopen in Container +3. Wait for the container to build and the postCreateCommand to run +4. Open a terminal in VS Code and run the following command: source obb/bin/activate + +> You can also click the Dev Containers badge at the top of the README to open the project in a Devcontainer. + ## Post-Installation With a fresh installation, and upon installing or uninstalling extensions, the Python interface needs to be built. This is done automatically, but can be manually triggered if required. Start a Python session and then `import openbb`: |