jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-30 22:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

adds debug mode instructions for terminal and sdk (#5145)

Browse Source
This commit is contained in:
Danglewood
2023-06-15 14:48:49 -07:00
committed by GitHub
parent e464b4ebbb
commit ae452852d7
3 changed files with 37 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
website/content/sdk/faqs/developer_issues.md vendored
View File

@@ -30,6 +30,24 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
## Developer Issues
<details><summary>How do I launch in debug mode?</summary>
The PyWry window can be run in debug mode for identifying specific issues. Use the code block below - with the `obb` Python environment active - to import the OpenBB SDK in debug mode.
```python
import os
from openbb_terminal.core.plots.backend import plots_backend
os.environ["DEBUG_MODE"] = "True"
plots_backend().start(True)
from openbb_terminal.sdk import openbb
```
The charts and tables will now include a developer tools button, located at the top-left of the window.
</details>
<details><summary>What branch on GitHub should pull requests be submitted to?</summary>
Pull requests submitted to the Main branch will not be merged, please create branches from the `develop` branch.

8
website/content/terminal/faqs/data_sources.md vendored
View File

@@ -38,7 +38,13 @@ The complete list is found [here](https://docs.openbb.co/terminal/usage/guides/a
</details>
<details><summary>How do I load a ticker symbol from India?</summary>
<details><summary>How do I find and load a ticker symbol from India, or any other country?</summary>
Use the [`/stocks/search`](https://docs.openbb.co/terminal/usage/intros/stocks#search) command.
```console
search --country canada --industrygroup banks
```
Ticker symbols listed on exchanges outside of the US will have a suffix attached, for example, Rico Auto Industries Limited:

12
website/content/terminal/faqs/developer_issues.md vendored
View File

@@ -28,6 +28,18 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Developer Issues - Terminal | OpenBB Docs" />
<details><summary>How do I launch in debug mode?</summary>
When installed from source, the OpenBB Terminal can be launched in debug mode. Launch the Terminal using the syntax below.
```python
python terminal.py --debug
```
Operate the Terminal normally, and errors will trigger an interrupt which prints the traceback with the error. Charts and tables will also include a developer tools button, located at the top-left of the window, for identifying issues specific to the PyWry interactive window.
</details>
<details><summary>What branch on GitHub should pull requests be submitted to?</summary>
Pull requests submitted to the Main branch will not be merged, please create branches from the `develop` branch.