Files
OpenBB/website/content/sdk/reference/alt/oss/top.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

2.0 KiB
Vendored

title, description
title description
top OpenBB SDK Function

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

top

Get repos sorted by stars or forks. Can be filtered by categories.

Source Code: [link]

openbb.alt.oss.top(sortby: str, limit: int = 50, categories: str = "")

Parameters

Name Type Description Default Optional
sortby str Sort repos by {stars, forks} None False
categories str Check for repo categories. If more than one separate with a comma: e.g., finance,investment. Default: None True
limit int Number of repos to search for 50 True

Returns

Type Description
pd.DataFrame Dataframe with repos

Plots repo summary [Source: https://api.github.com].

Source Code: [link]

openbb.alt.oss.top_chart(sortby: str, categories: str = "", limit: int = 10, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
sortby str Sort repos by {stars, forks} None False
categories str Check for repo categories. If more than one separate with a comma: e.g., finance,investment. Default: None True
limit int Number of repos to look at 10 True
export str Export dataframe data to csv,json,xlsx file True
external_axes Optional[List[plt.Axes]] External axes (1 axis is expected in the list), by default None None True

Returns

This function does not return anything