jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/alt/oss/summary.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.5 KiB
Vendored
Raw Blame History

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

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