pr_ai_gen 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11aeababc26896a5f2927d43b756e5b4b74275694fc7fe2f30e954a9823df3b3
-  data.tar.gz: 49c9e8b0aecf08d2d890cc8a290fc380fff805397c31b535d91ea946c089fc42
+  metadata.gz: f4f268ae0b385a4fa49eeceaef9162bb365312e4fdbe0d10e2d7d4f524eeb7ba
+  data.tar.gz: af463bc198f734340918e3111218256c8f10ed5d0da04619b3d903d2190f66e4
 SHA512:
-  metadata.gz: dc64d53865e5d51f3cf537124995b5f43779973a7094f71c451828a0e8263e44724b1eeb32ddaf1bd93bc542489effc88955da1a54a5d5dd71a77ec16f33e2b1
-  data.tar.gz: 7e327ab574ef06aa81192a8fe0421d96f5e0c12ea9b2d9c36b238f92bb84cb9136e84c222c169863e0e2abedcf55e16f29223c01e9f761d94e2ee4750e4538c4
+  metadata.gz: cc5fe7e238c9ee8277f74568b2e8cc3cba953b4dc4f95d6de559b5da547e93f7a4828e2f1d7a6ca4d73f23be09ece3b42e1df66ef5a9538f2b4bd5e851347d2e
+  data.tar.gz: 2c9eb8d5dbd3806a6132521e98f80cd4334c3d3ec879b094eef8fef67f347f8127fb912851b10a8343276ec8a33307319db488f098cc492742e2652e8d1f1133

data/README.md

@@ -0,0 +1,37 @@
+# pr_ai_gen
+
+## Description
+
+pr_ai_gen is a CLI tool that acelerate the process of creating pull requests by Generate the PR description in markdown format.
+It uses OpenAI to generate the content based on the differences between the two git branches beeing merged.
+
+## Installation
+
+Install the gem by running:
+
+```bash
+gem install pr_ai_gen
+```
+
+### Setup
+
+```bash
+pr_ai_gen init
+```
+The tool will ask you to input the OPENAI_TOKEN to make the ChatGPT calls. If you don't have one, please generate one [here](https://platform.openai.com/api-keys).
+After input the token if you want to change it you can change it in `~/.pr_gem/credentials`.
+
+### Usage
+
+When the setup is already done you will be good to use the tool.
+
+Commands: 
+- `generate <directory_location> <branch>:<target-branch=main>`: Generate the PR description based on diff from the branch and target-branch (default main)
+
+## Development
+
+To develop you must:
+1. make the script in exe directory executable
+`chmod -x ./exe/pr_ai_gen`
+2. run the script directly as it is the cli tool
+`./exe/pr_ai_gen generate <directory_location> <branch>:<target-branch=main>`

data/lib/pull_request_ai_generator.rb

@@ -14,6 +14,7 @@ class PullRequestAIGenerator
     @diff = nil
     @pr_content = nil
     @git_repo = nil
+    @config = nil
   end
 
   def init
@@ -28,13 +29,41 @@ class PullRequestAIGenerator
 
     if File.exist?(credentials_path)
       puts 'Credentials file already exists!'
-      return
+    else
+      puts 'Please enter your OpenAI API key:'
+      openai_token = STDIN.gets.chomp
+      File.write(credentials_path, "OPENAI_TOKEN=#{openai_token}\n")
+      puts 'Credentials file created successfully!'
+    end
+
+    puts 'Configuring ChatGPT integration'
+    puts 'Please choose the OpenAI API model:'
+    puts '1. gpt-4-turbo-preview'
+    puts '2. gpt-4'
+    puts '3. gpt-3.5-turbo'
+    
+    model = nil
+    while model.nil?
+      case STDIN.gets.chomp
+      when '1'
+        model = 'gpt-4-turbo-preview'
+      when '2'
+        model = 'gpt-4'
+      when '3'
+        model = 'gpt-3.5-turbo'
+      else
+        puts 'Invalid model! Please choose a valid model:'
+      end
     end
 
-    puts 'Please enter your OpenAI API key:'
-    openai_token = STDIN.gets.chomp
-    File.write(credentials_path, "OPENAI_TOKEN=#{openai_token}\n")
-    puts 'Credentials file created successfully!'
+    config = {
+      openai: {
+        model: model,
+        max_tokens: 1024
+      }
+    }
+
+    File.write(File.join(pr_gem_path, 'config.yml'), config.to_yaml)
   end
 
   def run
@@ -42,6 +71,7 @@ class PullRequestAIGenerator
     fetch_diff
     load_template
     get_openai_token
+    get_config
     generate_pr_content
     print_content
   end
@@ -110,6 +140,15 @@ class PullRequestAIGenerator
     end
   end
 
+  def get_config
+    config_path = File.join(File.expand_path('~/.pr-gem'), 'config.yml')
+    if File.exist?(config_path)
+      @config = YAML.load_file(config_path)
+    else
+      raise "Config file not found!"
+    end
+  end
+
   def get_openai_token
     credentials_path = File.expand_path('~/.pr-gem/credentials')
     if File.exist?(credentials_path)
@@ -132,14 +171,14 @@ class PullRequestAIGenerator
         "Authorization" => "Bearer #{@openai_token}"
       },
       body: {
-        model: "gpt-4-turbo-preview",
+        model: @config[:openai][:model],
         messages: [
           {
             role: "user",
             content: "fill this templete:\n #{@template}\n with the following changes:\n #{@diff.to_s}"
           },
         ],
-        max_tokens: 1024
+        max_tokens: @config[:openai][:max_tokens]
       }.to_json
     )
 

data/pr_ai_gen.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "pr_ai_gen"
-  spec.version       = "0.1.1"
+  spec.version       = "0.2.0"
   spec.authors       = ["Lucas Stoller"]
   spec.email         = ["l.s.stoller@gmail.com"]
   spec.summary       = "A CLI tool to generate pull requests using OpenAI"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pr_ai_gen
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Lucas Stoller
@@ -78,6 +78,7 @@ files:
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
+- README.md
 - exe/pr_ai_gen
 - lib/pull_request_ai_generator.rb
 - pr_ai_gen.gemspec