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

2.5 KiB
Vendored

title, description, keywords
title description keywords
top This content describes two features: 'Model' and 'Chart'. 'Model' gets repositories sorted by stars or forks with possible category filtering. 'Chart' plots a repo summary. Both procedures involve parameters like 'sortby', 'categories', 'limit', 'export', and 'external_axes'.
Documentation
Model
Chart
Repositories
Stars
Forks
Filtering
Parameters
Sortby
Categories
Limit
Export
External_axes

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

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

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