Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for setting API keys without revealing them #1224

Merged
merged 9 commits into from
Feb 4, 2025

Conversation

srdas
Copy link
Collaborator

@srdas srdas commented Feb 4, 2025

Description

Using the %env variable to set API keys echoes them and makes them visible. Hence, it is best to not use the command:

%env PROVIDER_API_KEY=YOUR_API_KEY_HERE

Instead, use

os.environ['PROVIDER_API_KEY'] = YOUR_API_KEY_HERE

Demo

This PR updates the related documentation to provide guidance on setting API keys. For example:

image

@srdas srdas added the documentation Improvements or additions to documentation label Feb 4, 2025
@srdas srdas requested a review from dlqqq February 4, 2025 01:05
@srdas srdas marked this pull request as ready for review February 4, 2025 01:07
Copy link
Member

@dlqqq dlqqq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@srdas Thanks! Have a few minor comments below.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/source/users/index.md Show resolved Hide resolved
@srdas srdas requested a review from dlqqq February 4, 2025 19:58
Copy link
Member

@dlqqq dlqqq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@srdas Awesome work, thanks!

@dlqqq dlqqq merged commit 94699a8 into jupyterlab:main Feb 4, 2025
9 checks passed
@dlqqq
Copy link
Member

dlqqq commented Feb 4, 2025

@meeseeksdev please backport to 2.x

meeseeksmachine pushed a commit to meeseeksmachine/jupyter-ai that referenced this pull request Feb 4, 2025
dlqqq pushed a commit that referenced this pull request Feb 4, 2025
@eugenio
Copy link

eugenio commented Feb 5, 2025

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
3 participants