Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] OpenBB Platform DevContainer #6426

Merged
merged 5 commits into from
May 17, 2024
Merged

[Feature] OpenBB Platform DevContainer #6426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6c4d552
devcontainer and its docs
hjoaquim May 16, 2024
8d1abad
typo
hjoaquim May 16, 2024
bf7471f
remove file
hjoaquim May 16, 2024
5c6384a
remove comments from json
hjoaquim May 17, 2024
3984d85
Merge branch 'develop' into feature/platform-devcontainer
hjoaquim May 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
]
}
}
}
14 changes: 0 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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">
Expand Down
11 changes: 11 additions & 0 deletions website/content/platform/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down
Loading