git-gpt 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0685c10e66a36290fd0eae99a4cd6d89ba6dd8ab630f8a562617be4af31cdd4
-  data.tar.gz: 35d25ec93cd1eee111a8a60b8ba1dc81f2accd58704185819850c29b0b3920bb
+  metadata.gz: 361917c413bdd904805df016c8b3574bc5fe27d5ac69b50e0bbbc6bd2eadfe37
+  data.tar.gz: e993f778f75d42f858dfd614fb758f920d08dbd75ab65e8db852ea6450dd1014
 SHA512:
-  metadata.gz: 128b5a721cd62d858a7e85e80367a4790d114fa6b955739e5ec489cd377ca198e142fdaae2b11f440ce4da94384ed7fa5d1e4ada8c6f3ff5483497ec2b61ad9f
-  data.tar.gz: c57883e32bbcf67804d84d268cc9d3cb5d0828774d62ee3163836fd559d75efa24d90c6bc5d9d26453fe1642f22997a04284f67bd495e16f71314f4f46483b82
+  metadata.gz: d09b73de08fa50e61feb3280b2e4178882b1da97bdcdeda0ac7b04b9257d28478b8468c9683b7e73e1af10e8c564e831b8f8d83a7a2e5f0984f505e797c8df98
+  data.tar.gz: 62a5a8e076e111351ff5261d5b31b93e3028894c97a7f35898fa764d7876af75f7833b9bb8bf586332beb84068d7663318c7d3cc022034b977e88eb74b4e1999

data/README.md

@@ -1,43 +1,77 @@
 # Git::Gpt
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/git/gpt`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+git-gpt is a ruby gem that adds an additional git subcommand, git gpt. It assists you in creating commit messages for your git changes. It uses the powerful capabilities of ChatGPT to generate commit messages based on the current git status and git diff. Additionally, you can specify a list of files to narrow down the context for the commit message.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+First, you need to install the gem. You can do this globally or in your specific Ruby environment.
 
-```ruby
-gem 'git-gpt'
+```sh
+gem install git-gpt
 ```
 
-And then execute:
+Once installed, it will be accessible as a git subcommand.
 
-    $ bundle install
+## Usage
 
-Or install it yourself as:
+You can invoke the `git gpt` command in your terminal anywhere in your git repository:
 
-    $ gem install git-gpt
 
-## Usage
+```sh
+git gpt
+```
+
+This will return a commit message generated by ChatGPT based on the changes detected by `git status` and `git diff`.
 
-TODO: Write usage instructions here
+If you wish to narrow down the context to a specific list of files, you can do so by passing them as arguments:
 
-## Development
+```sh
+git gpt file1 file2 file3
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+In the above example, `file1`, `file2`, and `file3` are placeholders for the file names you want to focus on. This will generate a commit message based on the changes in those files only.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### USAGE NOTE
 
-## Contributing
+`git gpt` does not actually commit your code, it simply prints a commit message that you can choose to use or not. If you run it multiple times, you will likely get different results.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/git-gpt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/git-gpt/blob/main/CODE_OF_CONDUCT.md).
+By default it asks ChatGPT to create short messages. If you like longer or multiline messages, you can adjust your prompt (see Advanced Configuration below).
 
-## License
+## Basic Configuration
+
+Best practice is to set the `OPENAI_API_KEY` environment veriable. Optionally, you can set `OPENAI_ORGANIZATION_ID`.
+
+## Advanced Configuration
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+By default `git gpt` uses `gpt-3.5-turbo` with a temperature of `0.7`. You can find the default prompt [here](https://github.com/assaydepot/git-gpt/blob/main/lib/git/gpt.rb#L12-L26). If you'd like to change the default settings, you can add a `.git-gpt-config.yml` file in your git repository. `git-gpt` will look for that file in the current directory, any parent directory (all the way to `/`) and your `HOME` directory. It will look in that order and use the first one it finds. The structure of the YAML file is as follows, all keys are optional.
 
-## Code of Conduct
+```yaml
+model: gpt-4
+temperature: 0.8
+openai_api_key: sk-acb1234567890xyz
+openai_organization_id: org-abc1234567890xyz
+prompt: >
+  You are a software engineer working on a project. You write diligent and detailed commit messages. You are working on a new feature and you are ready to commit your changes.
+
+  The current git status is:
+  \```
+  $GIT_STATUS
+  \```
+
+  The current git diff is:
+  \```
+  $GIT_DIFF
+  \```
+
+  Please write a commit message for this change. Format the commit message using markdown. You may use bullet points. Please comment specifically on any files with significant changes.
+```
+
+See a real example [here](https://github.com/assaydepot/git-gpt/blob/main/.git-gpt-config.yml).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/your-github-username/git-gpt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
+
+## License
 
-Everyone interacting in the Git::Gpt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/git-gpt/blob/main/CODE_OF_CONDUCT.md).
+The gem is available as open source under the terms of the MIT License.

data/git-gpt.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Chris Petersen"]
   spec.email = ["chris@petersen.io"]
 
-  spec.summary = "Use GPT-4 to generate commit messages"
-  spec.description = "Use GPT-4 to generate commit messages"
+  spec.summary = "Use ChatGPT to write your commit messages"
+  spec.description = "Use ChatGPT to write your commit messages"
   spec.homepage = "https://github.com/assaydepot/git-gpt"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"

data/lib/git/gpt/version.rb

@@ -2,6 +2,6 @@
 
 module Git
   module Gpt
-    VERSION = "0.0.1"
+    VERSION = "0.0.3"
   end
 end

data/lib/git/gpt.rb

@@ -2,6 +2,7 @@
 
 require_relative "gpt/version"
 require 'yaml'
+require 'json'
 require 'openai'
 
 module Git

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-gpt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Chris Petersen
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: Use GPT-4 to generate commit messages
+description: Use ChatGPT to write your commit messages
 email:
 - chris@petersen.io
 executables:
@@ -71,5 +71,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Use GPT-4 to generate commit messages
+summary: Use ChatGPT to write your commit messages
 test_files: []