Task/add readme

README.md

@@ -0,0 +1,64 @@
+# Welcome to HappyCommit!
+
+HappyCommit is a delightful tool that harnesses the power of OpenAI's GPT-3.5 Turbo language model to generate meaningful and descriptive Git commit messages for you. With HappyCommit, you can now focus on writing great code while we take care of crafting the perfect commit messages.
+
+## Prerequisites
+
+- Make sure you have [Homebrew](https://brew.sh/) installed on your macOS system.
+
+## Getting Started (macOS)
+
+1. To begin your journey with HappyCommit, install it by running the following commands:
+
+   ```bash
+   brew tap jackbackes/git-commit-gpt
+   brew install jackbackes/homebrew-git-commit-gpt/git-commit-gpt.rb
+   ```
+
+2. After the installation, let's add your OpenAI API key to the configuration file. Simply run the following command and enter your API key when prompted:
+
+   ```bash
+   printf "Enter your OPENAI_API_KEY: " && read -rs api_key && mkdir ~/.happycommit >> /dev/null && echo "OPENAI_API_KEY = \\\"$api_key\\\"" >> ~/.happycommit/config.toml
+   ```
+
+   Don't have an OpenAI API key yet? No worries! Grab one from your [OpenAI account](https://beta.openai.com/account/api-keys).
+
+3. That's it! HappyCommit is now ready to make your Git experience more enjoyable. Just use the `git commit-gpt` command to generate and add a commit message based on your code changes.
+
+### Getting Started (Linux)
+
+...Coming soon!
+
+### Getting Started (Windows)
+
+...Coming soon!
+
+### Getting Started (Build from source)
+
+1. Install Rust and Cargo by following the instructions [here](https://www.rust-lang.org/tools/install).
+2. Install the "Just" task runner by following the instructions [here](https://github.com/casey/just) or just run `cargo install just`.
+
+```bash
+git clone git@github.com:jackbackes/happycommit.git
+cd happycommit
+just install
+./add-openai-api-key.sh
+```
+
+## Usage
+
+Instead of running the standard `git commit` command, use this friendly alternative:
+
+```bash
+git commit-gpt
+```
+
+HappyCommit will analyze the changes in your code and generate a meaningful commit message that brings a smile to your face.
+
+## Contributing
+
+We'd love for you to join us in making HappyCommit even better! If you have suggestions, feature requests, or bug reports, please feel free to open an issue or submit a pull request on our GitHub repository. We're excited to see your contributions!
+
+## License
+
+HappyCommit is warmly licensed under the Apache License 2.0.

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"

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"

src/main.rs

@@ -230,16 +230,19 @@ fn load_api_key() -> Result<String, Box<dyn std::error::Error>> {
         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<String, Box<dyn std::error::Error>> {
         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)
     };