From 788e9a49a1d60b1f0049d9bccc19ff276f601ff8 Mon Sep 17 00:00:00 2001 From: John Backes Date: Mon, 17 Apr 2023 20:55:33 -0700 Subject: [PATCH 1/2] Update openai_api_key retrieval methods - Update config file to look for "OPENAI_API_KEY" instead of "openai_api_key" - Remove unnecessary error handling for .env file - Strip quotes from API key retrieved from config file The update to the config file is more consistent with the naming conventions of environment variables, and the removal of error handling for the .env file simplifies the code. Stripping the quotes from the retrieved API key ensures consistency and compatibility with other API key retrieval methods. Testing Done: - Manual testing done to ensure that API key is retrieved correctly with both config file and .env file methods. --- src/main.rs | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/main.rs b/src/main.rs index bd01929..70ad7dd 100644 --- a/src/main.rs +++ b/src/main.rs @@ -230,16 +230,19 @@ fn load_api_key() -> Result> { let config_path = dirs::home_dir().unwrap().join(".happycommit/config.toml"); let config = std::fs::read_to_string(config_path)?; let config: toml::Value = toml::from_str(&config)?; - let openai_api_key = config.get("openai_api_key"); + let openai_api_key = config.get("OPENAI_API_KEY"); if openai_api_key.is_none() { return Err("OPENAI_API_KEY not set in ~/.happycommit/config.toml".into()); } - Ok(openai_api_key.unwrap().to_string()) + let result = openai_api_key.unwrap().to_string(); + // strip quotes + let result = result.replace("\"", ""); + Ok(result) }; let dotenv_checker = || -> Result> { dotenv::dotenv().ok(); let openai_api_key = - dotenv::var("OPENAI_API_KEY").expect("OPENAI_API_KEY not set in .env file"); + dotenv::var("OPENAI_API_KEY")?; Ok(openai_api_key) }; From c5992094076a3130a131bc0932e3c94e7f921ea2 Mon Sep 17 00:00:00 2001 From: John Backes Date: Mon, 17 Apr 2023 21:02:31 -0700 Subject: [PATCH 2/2] Add script to add OpenAI API key to happycommit config file This commit adds a script, add-openai-api-key.sh, that allows users to add their OpenAI API key to happycommit's config file. The script checks if the API key already exists in the config file and prompts the user to update it if necessary. Once the key is added, users can run happycommit's git commit-gpt command to generate commit messages using GPT-3. Instructions for use: - Run the add-openai-api-key.sh script (found in jackbackes/happycommit on Github) to add your OpenAI API key to happycommit's config file. - Once the API key is added, run the git commit-gpt command to generate commit messages using GPT-3. Remember to proofread your commit message before submitting! --- add-openai-api-key.sh | 32 ++++++++++++++++++++++++++++++++ install-commit-gpt.sh | 34 ++++------------------------------ 2 files changed, 36 insertions(+), 30 deletions(-) create mode 100644 add-openai-api-key.sh diff --git a/add-openai-api-key.sh b/add-openai-api-key.sh new file mode 100644 index 0000000..9632da3 --- /dev/null +++ b/add-openai-api-key.sh @@ -0,0 +1,32 @@ +#!/bin/sh + +OPENAI_API_KEY="" +# Check if the OPENAI_API_KEY is already in the config file +if ! grep -qF "OPENAI_API_KEY" "$HOME/.happycommit/config.toml"; then + # Read the OPENAI_API_KEY from the user + printf "Please enter your OPENAI_API_KEY (you can get it at https://beta.openai.com/account/api-keys):\nNote: Your input will not be shown on the screen.\n> " + read -rs OPENAI_API_KEY + printf "\n" + # Add the OPENAI_API_KEY to the config.toml file + printf "OPENAI_API_KEY = \"%s\"\n" "$OPENAI_API_KEY" >> "$HOME/.happycommit/config.toml" +else + printf "OPENAI_API_KEY already exists in $HOME/.happycommit/config.toml\n" + printf "Would you like to update it? (y/n) " + read -r update + if [ "$update" = "y" ]; then + # TODO: Remove code duplication + printf "Please enter your OPENAI_API_KEY (you can get it at https://beta.openai.com/account/api-keys):\nNote: Your input will not be shown on the screen.\n> " + read -rs OPENAI_API_KEY + printf "\n" + # Remove the previous OPENAI_API_KEY from the config file + if [ "$machine" = "Mac" ]; then + sed -i '' '/OPENAI_API_KEY/d' "$HOME/.happycommit/config.toml" + else + sed -i '/OPENAI_API_KEY/d' "$HOME/.happycommit/config.toml" + fi + # Add the OPENAI_API_KEY to the config file + printf "OPENAI_API_KEY = \"%s\"\n" "$OPENAI_API_KEY" >> "$HOME/.happycommit/config.toml" + fi +fi + +printf "API Key added successfully. Happy committing!\n" \ No newline at end of file diff --git a/install-commit-gpt.sh b/install-commit-gpt.sh index 47163ac..416f7a7 100755 --- a/install-commit-gpt.sh +++ b/install-commit-gpt.sh @@ -69,34 +69,8 @@ if [ ! -f "$HOME/.happycommit/config.toml" ]; then touch "$HOME/.happycommit/config.toml" fi -OPENAI_API_KEY="" -# Check if the OPENAI_API_KEY is already in the config file -if ! grep -qF "OPENAI_API_KEY" "$HOME/.happycommit/config.toml"; then - # Read the OPENAI_API_KEY from the user - printf "Please enter your OPENAI_API_KEY (you can get it at https://beta.openai.com/account/api-keys):\nNote: Your input will not be shown on the screen.\n> " - read -rs OPENAI_API_KEY - printf "\n" - # Add the OPENAI_API_KEY to the config.toml file - printf "OPENAI_API_KEY = \"%s\"\n" "$OPENAI_API_KEY" >> "$HOME/.happycommit/config.toml" -else - printf "OPENAI_API_KEY already exists in $HOME/.happycommit/config.toml\n" - printf "Would you like to update it? (y/n) " - read -r update - if [ "$update" = "y" ]; then - # TODO: Remove code duplication - printf "Please enter your OPENAI_API_KEY (you can get it at https://beta.openai.com/account/api-keys):\nNote: Your input will not be shown on the screen.\n> " - read -rs OPENAI_API_KEY - printf "\n" - # Remove the previous OPENAI_API_KEY from the config file - if [ "$machine" = "Mac" ]; then - sed -i '' '/OPENAI_API_KEY/d' "$HOME/.happycommit/config.toml" - else - sed -i '/OPENAI_API_KEY/d' "$HOME/.happycommit/config.toml" - fi - # Add the OPENAI_API_KEY to the config file - printf "OPENAI_API_KEY = \"%s\"\n" "$OPENAI_API_KEY" >> "$HOME/.happycommit/config.toml" - fi -fi - # Done! -printf "git commit-gpt installed successfully. You can now use 'git commit-gpt' to run happycommit.\n" +printf "git commit-gpt installed successfully. +printf "You should now run 'add-openai-api-key' to add your OpenAI API key to happycommit's config file.\n" +printf "This script can be found in jackbackes/happycommit on github.\n" +You can now use 'git commit-gpt' to run happycommit.\n"