jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-02 07:23:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
948d2ef29900c48ec26616eb48ba952aaaadd883
OpenBB/website/content/sdk/reference/alt/oss/summary.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

1.9 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
summary This documentation page contains comprehensive information on OpenBB's repository summary and chart view options. You can retrieve a summary with OpenBB library and display it in a chart view. Includes source code links and detailed parameter descriptions for usage.
Repository Summary
Chart View
Source Code
Github
Docusaurus
API

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

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Get repository summary.

Source Code: [link]

openbb.alt.oss.summary(repo: str)

Parameters

Name Type Description Default Optional
repo str Repo to search for Format: org/repo, e.g., openbb-finance/openbbterminal None False

Returns

Type Description
pd.DataFrame Dataframe with repo summary - Columns: Metric, Value

Prints table showing repo summary [Source: https://api.github.com].

Source Code: [link]

openbb.alt.oss.summary_chart(repo: str, export: str = "")

Parameters

Name Type Description Default Optional
repo str Repository to display summary. Format: org/repo, e.g., openbb-finance/openbbterminal None False
export str Export dataframe data to csv,json,xlsx file True

Returns

This function does not return anything