Files
Danglewood 3a8a71dd15 [Docs] Refactor Docs Pages For Diataxis (#6315)
* This change creates a PR

* start moving stuff around

* data_models/_category_.json

* reference/_category_.json

* moving some stuff around

* Introduction

* Documentation updates

* few broken links, clean up sidebar titles for how-to

* codespell

* quickstart - new provider extension

* add a comment

* map provider interface

* quickstart for new router extension

* [Docs] diataxis refactor refactor (#6425)

* Start refactor

* Edits

* [DOCS] Reorganize and edit. Fix sidebar navigation (#6445)

* Reorganize and edit. Fix sidebar navigation

* Fix broken linkages

* Edit

---------

Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>

* Fix links

---------

Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>

* Fix broken links

* Reword CLA part in the Licensing FAQ

* change titles and order suggestion - cc @IgorWounds @piiq

---------

Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: hjoaquim <henriquecjoaquim@gmail.com>
2024-05-22 13:50:43 +00:00

1.5 KiB
Vendored

title, sidebar_position, description, keywords
title sidebar_position description keywords
Installation 1 This page outlines the installation of the openbb-charting extension.
tutorial
OpenBB Platform
Installation
Python client
Fast API
getting started
extensions
charting
view
Plotly
toolkit
community
Plotly
OpenBBFigure
PyWry

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

PyPI

To install the extension, run the following command in this folder:

pip install openbb-charting

Find the latest version on PyPI.

Editable Mode

To install from source in editable mode, navigate into the folder, ~/openbb_platform/extensions/charting, and enter:

pip install -e .

After installation, the Python interface will automatically rebuild on initialization. This process can also be triggered manually with:

import openbb
openbb.build()

The Python interpreter may need to be restarted.

PyWry Dependency In Linux

When using Linux distributions, the PyWry dependency requires certain dependencies to be installed first.

  • Debian-based / Ubuntu / Mint: sudo apt install libwebkit2gtk-4.0-dev

  • Arch Linux / Manjaro: sudo pacman -S webkit2gtk

  • Fedora: sudo dnf install gtk3-devel webkit2gtk3-devel

If Rust (Cargo) is required, install it:

curl --proto '=https' --tlsv1.3 https://sh.rustup.rs -sSf | sh