search

zenml-io / vscode-zenml

VSCode extension for ZenML
Apache License 2.0
12 stars 9 forks source link

Feature: Register OpenAI API key #31

Closed sklarfox closed 2 months ago

sklarfox commented 2 months ago

This pull request adds the ability to register an OpenAI API secret using VSCode's SecretStorage API.

It adds one command to the command palette Register OpenAI API Key. You can use that to add/update your API key. It currently only supports OpenAI, but will be updated in the future to support other LLMs.

To retrieve the API key, import the async function getSecret from src/common/vscodeapi.ts. You have to pass it an ExtensionContext object as an argument, along with a string for whichever secret you want (for OpenAI it will be 'OPENAI_API_KEY'). How exactly you get the ExtensionContext object is going to depend on how / where your code is executed.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes introduce functionality for managing OpenAI and Large Language Model (LLM) API keys within a Visual Studio Code extension. This includes the addition of commands for registering these API keys, securely handling secrets, and enhancing the overall capabilities of the ZenML environment. The updates span multiple files, establishing a structured approach to API key management and secret storage.

Changes

File Change Summary
package.json Added command entries for registering OpenAI and LLM API keys.
src/commands/secrets/cmds.ts Implemented registerOpenAIAPIKey and registerLLMAPIKey functions for secure key management.
src/commands/secrets/registry.ts Defined registerSecretsCommands function to register secrets-related commands.
src/common/vscodeapi.ts Introduced getSecret function for retrieving secrets securely using the provided context.

Poem

🐇✨
In the garden of code, a secret we keep,
An API key tucked away, safe in its sleep.
With a hop and a jump, it’s now easy to find,
ZenML's magic has flourished, oh so kind!
So let’s celebrate changes, both shiny and bright,
A brave little bunny dances in delight!
🌟🥕

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Early access features: disabled We are currently testing the following features in early access: - **Anthropic `claude-3-5-sonnet` for code reviews**: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues on the [discussion post](https://discordapp.com/channels/1134356397673414807/1279579842131787838).
strickvl commented 2 months ago

@coderabbitai review

coderabbitai[bot] commented 2 months ago
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
sklarfox commented 2 months ago

@strickvl Thanks for the review! I've generalized the function to now also support Anthropic and Gemini on top of OpenAI.

sklarfox commented 2 months ago

I've made one additional change to the code; I have changed the naming convention for the secrets to prevent collision issues with other extensions. The previous names were {provider}_API_KEY, but this seemed a little generic and could collide with other secrets the the vscode store. The new naming scheme is zenml.{provider}.key, which is similar to other extensions' implementations.

strickvl commented 2 months ago

@coderabbitai review

coderabbitai[bot] commented 2 months ago
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.