mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-10 11:21:12 +00:00
6e9fefce9e
* feat: adds bot docs to docu * fix: file structure * fix: brings changelog and switch platform button * adding available options and changing Example text * fix: detect whether iframe, fix availableoptions component, dynamic update third friday for options component * fix: updated readme to reflect new changes * fix: made it so from iframe only shows relevant sidebar * PLAY BUTTON WOOO - works on discord/charting/chart * comment * fix: search bar, improve search * fix: hijacks ctrl+k from iframe, adds visit to hub link * about * setting up play button for all images on Discord * Bot docs updates * terminal/faqs * update main page * add changelog to terminal * SDK refactoring * minor reordering * bot struct in place * move bot faqs over * updating bot index and installation * add new letterings * fix: adds new navbar * fix: new bot images and layouts * updating installation and flow * black linter * spelling * spelling * The best commit --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> Co-authored-by: James Maslek <jmaslek11@gmail.com>
136 lines
4.1 KiB
Markdown
Vendored
136 lines
4.1 KiB
Markdown
Vendored
---
|
|
title: Developer Issues
|
|
sidebar_position: 7
|
|
description: TBD
|
|
keywords:
|
|
[
|
|
installation,
|
|
installer,
|
|
install,
|
|
guide,
|
|
mac,
|
|
windows,
|
|
linux,
|
|
python,
|
|
github,
|
|
macos,
|
|
how to,
|
|
explanation,
|
|
openbb terminal,
|
|
]
|
|
---
|
|
|
|
## Developer Issues
|
|
|
|
<details><summary>Error: "git pull" fails because of a hot fix: cannot lock ref</summary>
|
|
|
|
If the error message looks something like:
|
|
|
|
```console
|
|
cannot lock ref: 'refs/remotes/origin/hotfix' exists; cannot create
|
|
```
|
|
|
|
Try:
|
|
|
|
```console
|
|
git remote prune origin
|
|
git pull
|
|
```
|
|
|
|
</details>
|
|
|
|
<details><summary>What does it mean if it says wheel is missing?</summary>
|
|
|
|
If you receive any notifications regarding `wheel` missing, this could be due to this dependency missing.
|
|
|
|
`conda install -c conda-forge wheel` or `pip install wheel`
|
|
|
|
</details>
|
|
|
|
<details><summary>Why do these .whl files not exist?</summary>
|
|
|
|
If you get errors about .whl files not existing (usually on Windows) you have to reinitialize the following folder.
|
|
Just removing the 'artifacts' folder could also be enough:
|
|
|
|
| Platform | Location |
|
|
| -------- | ------------------------------- |
|
|
| Linux | "~/.cache/pypoetry" |
|
|
| Mac | "~/Library/Caches/pypoetry" |
|
|
| Windows | "%localappdata%/pypoetry/cache" |
|
|
|
|
When you try to add a package to Poetry it is possible that it causes a similar issue. Here you can remove the
|
|
'artifacts' folder again to reinitialize Poetry.
|
|
|
|
If you run into trouble with Poetry, and the advice above did not help, your best bet is to try
|
|
|
|
- `poetry update --lock`
|
|
- `conda deactivate` -> `conda activate obb`, then try again
|
|
- Track down the offensive package and purge it from your anaconda `<environment_name>` folder, then try again
|
|
|
|
| Platform | Location |
|
|
| --------- | ------------------------------------------- |
|
|
| Linux/Mac | ~/anaconda3/envs, or , ~/opt/anaconda3/envs |
|
|
| Windows | %userprofile%/anaconda3/envs |
|
|
|
|
- Completely nuke your conda environment folder and make a new environment from scratch
|
|
|
|
- `conda deactivate`
|
|
- `conda env remove -n obb`
|
|
- `conda clean -a`
|
|
- Make a new environment and install dependencies again.
|
|
- Reboot your computer and try again
|
|
- Submit a ticket on GitHub
|
|
|
|
</details>
|
|
|
|
<details><summary>What does the JSONDecodeError mean during poetry install?</summary>
|
|
|
|
Sometimes poetry can throw a `JSONDecodeError` on random packages while running `poetry install`. This can be observed on macOS 10.14+ running python 3.8+. This is because of the use of an experimental installer that can be switched off to avoid the mentioned error. Run the code below as advised [here](https://github.com/python-poetry/poetry/issues/4210) and it should fix the installation process.
|
|
|
|
```bash
|
|
poetry config experimental.new-installer false
|
|
```
|
|
|
|
_Commands that may help you in case of an error:_
|
|
|
|
- `python -m pip install --upgrade pip`
|
|
- `poetry update --lock`
|
|
- `poetry install`
|
|
|
|
</details>
|
|
|
|
<details><summary>How do I deal with errors regarding CRLF?</summary>
|
|
|
|
When trying to commit code changes, pylint will prevent you from doing so if your line break settings are set to
|
|
CRLF (default for Windows).
|
|
This is because the entire package uses LF (default for Linux/Mac), and it is therefore
|
|
important that you change this setting to LF _before_ you make any changes to the code.
|
|
|
|
It is possible that CRLF automatically turns back on, you can correct this with:
|
|
|
|
```bash
|
|
git config --global core.autocrlf false
|
|
```
|
|
|
|
In case you already made coding adjustments, you have to reset your cache, and the changes you made to the code with
|
|
the following:
|
|
|
|
```bash
|
|
git rm --cached -r .
|
|
git reset --hard
|
|
```
|
|
|
|
</details>
|
|
|
|
<details><summary>Why can't I run OpenBB via the VS Code integrated terminal?</summary>
|
|
|
|
This occurs when VS Code terminal python version/path is different from the terminal version.
|
|
|
|
To fix it add this to vscode JSON settings ([ref](https://stackoverflow.com/questions/54582361/vscode-terminal-shows-incorrect-python-version-and-path-launching-terminal-from)):
|
|
|
|
```bash
|
|
"terminal.integrated.inheritEnv": false,
|
|
```
|
|
|
|
</details>
|