Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/alt/oss/top.md
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

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