Files
OpenBB/website/content/sdk/faqs/developer_issues.md
jose-donato 6e9fefce9e Adds bot documentation to docusaurus and changes for hub (#4409)
* 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>
2023-03-16 16:29:57 +00:00

4.1 KiB
Vendored

title, sidebar_position, description, keywords
title sidebar_position description keywords
Developer Issues 7 TBD
installation
installer
install
guide
mac
windows
linux
python
github
macos
how to
explanation
openbb terminal

Developer Issues

Error: "git pull" fails because of a hot fix: cannot lock ref

If the error message looks something like:

cannot lock ref: 'refs/remotes/origin/hotfix' exists; cannot create

Try:

git remote prune origin
git pull
What does it mean if it says wheel is missing?

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

Why do these .whl files not exist?

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

What does the JSONDecodeError mean during poetry install?

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 and it should fix the installation process.

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
How do I deal with errors regarding CRLF?

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:

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:

git rm --cached -r .
git reset --hard
Why can't I run OpenBB via the VS Code integrated terminal?

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):

    "terminal.integrated.inheritEnv": false,