Files
OpenBB/website/content/platform/contributing/platform-development/manage_extensions.md
Igor Radovanovic 83aa83f988 Improve SEO
2023-10-03 17:27:17 +02:00

1.3 KiB
Vendored

title, sidebar_position, description, keywords
title sidebar_position description keywords
Manage Extensions 4 Learn how to manage extensions in the OpenBB Platform.
openbb
platform
introduction
manage extensions
contributing
documentation
pypi

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

To install extensions hosted on PyPI, use the pip install <extension> command.

To install an extension that is developed locally, ensure that it contains a pyproject.toml file and then use the pip install <extension> command.

To install the extension in editable mode using pip, add the -e argument.

Alternatively, for local extensions, you can add this line in the LOCAL_DEPS variable in dev_install.py file:

# If this is a community dependency, add this under "Community dependencies",
# with additional argument optional = true
openbb-extension = { path = "<relative-path-to-the-extension>", develop = true }

Now you can use the python dev_install.py [-e] command to install the local extension.

Add an extension as a dependency

To add the openbb-qa extension as a dependency, you'll need to add it to the pyproject.toml file:

[tool.poetry.dependencies]
openbb-qa = "^0.0.0a2"

Then you can follow the same process as above to install the extension.