mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 04:52:07 +00:00
4ad995fdd0
* 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>
56 lines
1.5 KiB
Markdown
Vendored
56 lines
1.5 KiB
Markdown
Vendored
---
|
|
title: github
|
|
description: The page guides users on how to set a GitHub API key using the OpenBBTerminal.
|
|
It provides explanations about the parameters involved and gives a brief glimpse
|
|
into the possible return values. The page also includes code examples as useful
|
|
guidance.
|
|
keywords:
|
|
- github
|
|
- API key
|
|
- key set
|
|
- terminal environment variables
|
|
- Jupyter notebook session
|
|
- key persistence
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="keys.github - Reference | OpenBB SDK Docs" />
|
|
|
|
Set GitHub key.
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L2148)]
|
|
|
|
```python
|
|
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.<br/>If True, api key change will be global, i.e. it will affect terminal environment variables.<br/>By default, False. | False | True |
|
|
| show_output | bool | Display status string or not. By default, False. | False | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| str | Status of key set |
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
openbb.keys.github(key="example_key")
|
|
```
|
|
|
|
---
|