mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 16:02:04 +00:00

Files

Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470 )

* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>

2023-09-29 11:49:05 +02:00

title, description

title	description
summary	OpenBB SDK Function

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

summary

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

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 = "")

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

This function does not return anything