mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 13:01:38 +00:00
c047cfeddd
* move old example notebooks to v3 folder, update loadHistoricalPriceData and add findSymbols * Create README.md * Update README.md * Update README.md * Update README.md * Vertical diagram instead * important classes * core dependencies * folder structure * devtools * swap order * fix github pages deploy issue * development index * delete expectations for developers * devtools * obbject stuff * add * installation * hub sync * idk if i committed already * add usage page for financial statements * add link to reference page * syntax * numbers * nearly --> more than * easier to read code blocks * codespell * removing mention to provider * add 'orientation' for to_dict * info card for output user preference * put it in a code block * correct user_settings.json example * syntax corrections * fix sentence * get rid of floating point mathc * get rid of other floating point math * add companion example notebook for financial statements, and new section * historical prices usage page * codespell * add commitment of traders section to usage * add a note * codespell * get rid of equals sign * Cleanup docs. with @the-praxs * install * obbject extend * spell * HeadTitle thingies * Update obbject_extensions.md * Update obbject_extensions.md * typo * Update architectural_considerations.md * point to the TET pattern * optional vs required * reviewing the patterns. removed the --pre flag under the assumption this will be the final docs for the release cc @deeleeramone * add a walkthrough * spelling * Add more in the introduction * validator examples * update Copper-to-Gold notebook example for V4 * Update README.md * QA Caveats w @the-praxs * info on class outputs * merge add data sources and add data points * disclaimer on cookiecutter * add missing import to example * slight syntax change * missing code block * missing import * update intrinio example syntax * intrinio syntax update * urls * core and provider merged * example syntax * grammar * Update API banner link * quick-fix-docs cc @minhhoang1023 * Update pip install command for v3 * remove --pre note block * update landing image --------- Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: Luqman <luqazino@gmail.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
1.9 KiB
Vendored
1.9 KiB
Vendored
title, sidebar_position, description, keywords
| title | sidebar_position | description | keywords | ||||
|---|---|---|---|---|---|---|---|
| Dependency Management | 3 | Dealing with dependencies when developing with the OpenBB Platform. Learn how to add new dependencies to the OpenBB Platform and how to add new dependencies to your custom extension. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
High-Level Overview
- Core: Serves as the main infrastructural package.
- Extensions: Utility packages that leverage Core's infrastructure. Each extension is its own package.
- Providers: Utility packages extending functionality to different providers, where each provider is its own package.
Core Dependency Management
Installation
- pip:
pip install -e OpenBBTerminal/openbb_platform/platform/core - poetry:
poetry install OpenBBTerminal/openbb_platform/platform/core
Using Poetry
Ensure you're in a fresh conda environment before adjusting dependencies.
- Add a Dependency:
poetry add <my-dependency> - Update Dependencies:
- All:
poetry update - Specific:
poetry update <my-dependency>
- All:
- Remove a Dependency:
poetry remove <my-dependency>
Core and Extensions
Dev Installation
For development setup, use the provided script to install all extensions and their dependencies:
python dev_install.py [-e|--extras]
Note
: If developing an extension, avoid installing all extensions to prevent unnecessary overhead.
Dependency Management with Poetry
- Add Platform Extension:
poetry add openbb-extension-name [--dev] - Resolve Conflicts: Adjust versions in
pyproject.tomlif notified by Poetry. - Lock Dependencies:
poetry lock - Update Platform:
poetry update openbb-platform - Documentation: Maintain
pyproject.tomlandpoetry.lockfor a clear record of dependencies.