mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +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
github	OpenBB SDK Function

github

Set GitHub key.

Source Code: [link]

openbb.keys.github(key: str, persist: bool = False, show_output: bool = False)

Parameters

Name	Type	Description	Default	Optional
key	str	API key	None	False
persist	bool	If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session. If True, api key change will be global, i.e. it will affect terminal environment variables. By default, False.	False	True
show_output	bool	Display status string or not. By default, False.	False	True

Type	Description
str	Status of key set

from openbb_terminal.sdk import openbb
openbb.keys.github(key="example_key")