openai-please 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d2e77c2b839915788f9db15c6f6a75b90d3c52c4a9033f3145aa687ff0d21a3
-  data.tar.gz: b021e9384596d305d472224ee726cd9a4f16c514cc378c051d079b1ac9c58555
+  metadata.gz: f57df851a98cb38c098cae4762fb1174ceb8a43e6bae36104c1dcc479fbcedb9
+  data.tar.gz: 23e3002663ae954bfd109500a7bedde579a5f28add34fb94abfdf114a48dbe92
 SHA512:
-  metadata.gz: 3f349c795f25116281574e882f2299104654d399a29dc7481d1066ca576d8f6bb2f754b25dd12d6d9725aa4edc677fac7bb827e10307a69caee0da03f471cee9
-  data.tar.gz: 97014f5dfc48adb96767c9b52996511d1cc2d1666256c0f8720181503b9aa9780c5c81ad34ae384c8e880ac9c853e3c9b25f795a0ccad78a6fab27a002f02e32
+  metadata.gz: fa0e870e7d6ef5cb147ea92b96ecaf6b5dae6c4c138732dfcca90a2af5646be62fdc1aa59931aa19c5d1f4197616116d223f218e4bd4df190a4bd41f5e30cb44
+  data.tar.gz: 32b6ebf0c3fa2f5228dfd2a97ff019e01984d59f92e27d1f50fafbaab53b841c00be4b4678d1caf87983a8b00a3770d4488a7746aecf3eeeac92936680c71a8e

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 .env
+config.yml

data/.rubocop.yml

@@ -19,8 +19,15 @@ Style/TrailingCommaInArguments:
   Enabled: true
   EnforcedStyleForMultiline: comma
 
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
 Style/Documentation:
   Enabled: false
 
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
 Layout/LineLength:
-  Max: 120
+  Enabled: false

data/Gemfile.lock

@@ -1,21 +1,18 @@
 PATH
   remote: .
   specs:
-    openai-please (0.1.1)
-      ruby-openai (>= 1.3)
-      tty-prompt (>= 0.23)
+    openai-please (0.2.0)
+      ruby-openai (~> 3.0)
+      tty-prompt (~> 0.23)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    dotenv (2.7.6)
-    httparty (0.18.1)
-      mime-types (~> 3.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0901)
+    mini_mime (1.1.2)
     minitest (5.14.4)
     multi_xml (0.6.0)
     parallel (1.21.0)
@@ -38,9 +35,8 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.11.0)
       parser (>= 3.0.1.1)
-    ruby-openai (1.3.1)
-      dotenv (~> 2.7.6)
-      httparty (~> 0.18.1)
+    ruby-openai (3.0.3)
+      httparty (>= 0.18.1, < 0.22.0)
     ruby-progressbar (1.11.0)
     tty-color (0.6.0)
     tty-cursor (0.7.1)
@@ -65,4 +61,4 @@ DEPENDENCIES
   rubocop (~> 1.7)
 
 BUNDLED WITH
-   2.2.22
+   2.4.3

data/README.md

@@ -10,7 +10,7 @@ Convert natural language to bash commands using OpenAI Codex
 
     $ gem install openai-please
 
-Ensure your [OpenAI API key](https://help.openai.com/en/articles/5480100-how-do-i-gain-access-to-openai-codex) is stored in an environment variable.
+Provide your [OpenAI API key](https://help.openai.com/en/articles/5480100-how-do-i-gain-access-to-openai-codex) in an environment variable, or using the [configuration file](#configuration).
 
 ```
 OPENAI_ACCESS_TOKEN=[YOUR ACCESS TOKEN HERE]
@@ -18,20 +18,66 @@ OPENAI_ACCESS_TOKEN=[YOUR ACCESS TOKEN HERE]
 
 ## Usage
 
+Type `please`, followed by an instruction written in natural language.
+
 ```shell
 user@host:~$ please find all files larger than 1 mb
 $ find . -type f -size +1M
 Run the command? (enter "h" for help) [y,n,e,h]
 ```
 
-You can [e]dit the command before running it by pressing the 'e' key. This uses the editor specified in the $EDITOR variable, defaulting to vi.
+You can [e]dit the command before running it by pressing the 'e' key. This uses the command specified in the `$EDITOR` variable, or `vi` if no editor is set.
+
+See `please --help` for more information.
+
+## Configuration
+
+You can modify the default configuration in `~/.config/please/config.yml`.
+
+```yaml
+send_pwd: false             # default: true
+send_ls: false              # default: true
+send_uname: true            # default: true
+
+access_token: ...           # default: $OPENAI_ACCESS_TOKEN
+
+examples:                   # default: []
+  - instruction: Run my super secret command
+    command: /super/secret/command
+    
+  - instruction: Show git status
+    command: git status
+    execute: true           # default: false
+    
+skip_default_examples: true # default: false
+```
+
+### `examples`
+
+Any examples listed here will be added to the prompt in the following form.
+
+```
+# INSTRUCTION
+$ COMMAND
+[RESULT, if execute is set to true]
+```
+
+If `execute` is set to true, the command will be executed prior to sending the request and the result will be included in the prompt. This is useful for providing dynamic context which the AI can use to inform completions.
+
+### `skip_default_examples`
+
+Do not include the default set of examples in the prompt. You can see the full prompt by running `please --show-prompt`. 
+
+*Note:* This option does not automatically imply `send_*: false`. To remove all examples from the prompt other than those explicitly specified, use this option in combination with the `send_*: false` options.
 
 ## Privacy
 
-In addition to the instruction text, the result of each of the following commands is sent to OpenAI Codex to improve the relevance of completions.
+By default, the result of each of the following commands is sent to OpenAI Codex to improve the relevance of completions.
 
 - `pwd`
 - `uname -a`
 - `ls -a`
 
+This behaviour can be disabled using the configuration options described above. You can review the prompt before sending it to OpenAI by running `please --show-prompt`. 
+
 See [OpenAI's privacy policy](https://beta.openai.com/policies/privacy-policy) for more information.

data/docker-compose.yml

@@ -8,3 +8,4 @@ services:
     env_file: .env
     volumes:
       - '.:/app'
+      - './config.yml:/root/.config/please/config.yml:ro'

data/lib/please/cli.rb

@@ -2,10 +2,14 @@
 
 require 'English'
 require 'tty-prompt'
+require 'yaml'
 require 'optparse'
 require 'please'
 require 'tempfile'
 
+USAGE = 'Usage: please [options] <instruction>'
+CONFIG_FILE_PATH = File.expand_path('~/.config/please/config.yml')
+
 begin
   tty_prompt = TTY::Prompt.new
 
@@ -14,13 +18,27 @@ begin
     send_pwd: true,
     send_uname: true,
     send_ls: true,
+    access_token: ENV.fetch('OPENAI_ACCESS_TOKEN', nil),
+    examples: [],
+    skip_default_examples: false,
   }
 
-  USAGE = 'Usage: please [options] <instruction>'
+  if File.exist?(CONFIG_FILE_PATH)
+    begin
+      options.merge! YAML.load_file(CONFIG_FILE_PATH).transform_keys(&:to_sym)
+      options[:examples].each { |example| example.transform_keys!(&:to_sym) }
+    rescue StandardError
+      tty_prompt.warn 'Could not parse config file. Ignoring.'
+    end
+  end
 
   OptionParser.new do |opts|
     opts.banner = USAGE
 
+    opts.on('--show-config-path', 'Output the location of the config file, and then exit') do |v|
+      options[:show_config_path] = v
+    end
+
     opts.on('--show-prompt', 'Output the prompt that would ordinarily be sent to OpenAI Codex, and then exit') do |v|
       options[:show_prompt] = v
     end
@@ -38,12 +56,17 @@ begin
     end
   end.parse!
 
-  access_token = ENV.fetch('OPENAI_ACCESS_TOKEN') do
-    tty_prompt.error 'Ensure the OPENAI_ACCESS_TOKEN environment variable is set'
+  if options[:show_config_path]
+    tty_prompt.say CONFIG_FILE_PATH
+    exit
+  end
+
+  if options[:access_token].nil?
+    tty_prompt.error "Access token not found. Set it in #{CONFIG_FILE_PATH} or $OPENAI_ACCESS_TOKEN."
     exit 1
   end
 
-  codex_service = Please::OpenAI::CodexService.new(access_token: access_token)
+  codex_service = Please::OpenAI::CodexService.new(access_token: options[:access_token])
 
   instruction = ARGV.join(' ')
 

data/lib/please/context.rb

@@ -1,30 +1,69 @@
 # frozen_string_literal: true
 
+DEFAULT_EXAMPLES = [
+  {
+    instruction: 'Find all files older than 1 week and open each of them in vim',
+    command: 'find . -type f -mtime +7 -exec vim {} \;',
+  },
+
+  {
+    instruction: 'Show a clock which updates every second on a single line',
+    command: 'printf \'import time\nwhile True:\n\tprint(time.strftime("%%H:%%M:%%S"), end="\\\\r")\n\ttime.sleep(1)\' > /tmp/program.py; python3 /tmp/program.py; rm /tmp/program.py',
+  },
+
+  {
+    instruction: 'Write a python program that prints out hello world with each letter on its own line',
+    command: 'printf \'print("\\\\n".join(list("Hello World"))\' > /tmp/program.py; python3 /tmp/program.py; rm /tmp/program.py',
+  },
+
+  {
+    instruction: 'Read from stdin until EOF, and then output the length of the string',
+    command: 'printf \'import sys\nprint(len(sys.stdin.read().strip()))\' > /tmp/program.py; python3 /tmp/program.py; rm /tmp/program.py',
+  },
+
+  {
+    instruction: 'Run the fortune command 5 times',
+    command: 'for i in $(seq 5); do fortune; done',
+  },
+
+  {
+    instruction: 'Repeadedly read a single line from the user, reverse it, and print it back',
+    command: 'printf \'while True:\n\tline = input()\n\tprint(line[::-1])\' > /tmp/program.py; python3 /tmp/program.py; rm /tmp/program.py',
+  },
+].freeze
+
+OPTIONAL_EXAMPLES = {
+  pwd: {
+    instruction: 'Print the current working directory',
+    command: 'pwd',
+    execute: true,
+  },
+
+  uname: {
+    instruction: 'Show information about the operating system',
+    command: 'uname -a',
+    execute: true,
+  },
+
+  ls: {
+    instruction: 'List all files in the current directory',
+    command: 'ls -a',
+    execute: true,
+  },
+}.freeze
+
 module Please
   class Context
     def initialize(options)
-      @examples = default_examples
+      @examples = []
 
-      if options[:send_pwd]
-        @examples << {
-          instruction: 'Print the current working directory',
-          command: 'pwd',
-        }
-      end
+      @examples += DEFAULT_EXAMPLES unless options[:skip_default_examples]
 
-      if options[:send_uname]
-        @examples << {
-          instruction: 'Show information about the operating system',
-          command: 'uname -a',
-        }
-      end
+      @examples << OPTIONAL_EXAMPLES[:pwd] if options[:send_pwd]
+      @examples << OPTIONAL_EXAMPLES[:uname] if options[:send_uname]
+      @examples << OPTIONAL_EXAMPLES[:ls] if options[:send_ls]
 
-      if options[:send_ls]
-        @examples << {
-          instruction: 'List all files in the current directory',
-          command: 'ls -a',
-        }
-      end
+      @examples += options[:examples]
     end
 
     def to_s
@@ -32,45 +71,9 @@ module Please
         <<~EXAMPLE.chomp
           # #{example[:instruction]}
           $ #{example[:command]}
-          #{example.fetch(:result) { `#{example[:command]}` }}
+          #{example[:execute] ? `#{example[:command]}` : ""}
         EXAMPLE
       end.join("\n")
     end
-
-    private
-
-    def default_examples
-      [
-        {
-          instruction: 'Find all files older than 1 week and open each of them in vim',
-          command: 'find . -type f -mtime +7 -exec vim {} \;',
-          result: '',
-        },
-
-        {
-          instruction: 'Download a random dog picture',
-          command: 'printf \'import urllib.request\nimport json\nimport subprocess\ndata = urllib.request.urlopen("https://dog.ceo/api/breeds/image/random").read()\nurl = json.loads(data)["message"]\nsubprocess.call(["curl", url, "-o", "dog.jpg"])\' > /tmp/program.py; python3 /tmp/program.py; rm /tmp/program.py',
-          result: '',
-        },
-
-        {
-          instruction: 'Read from stdin until EOF, and then output the length of the string',
-          command: 'printf \'import sys\nprint(len(sys.stdin.read().strip()))\' > /tmp/program.py; python3 /tmp/program.py; rm /tmp/program.py',
-          result: '',
-        },
-
-        {
-          instruction: 'Run the fortune command 5 times',
-          command: 'for i in $(seq 5); do fortune; done',
-          result: '',
-        },
-
-        {
-          instruction: 'Repeadedly read a single line from the user, reverse it, and print it back',
-          command: 'printf \'while True:\n\tline = input()\n\tprint(line[::-1])\' > /tmp/program.py; python3 /tmp/program.py; rm /tmp/program.py',
-          result: '',
-        },
-      ]
-    end
   end
 end

data/lib/please/openai/codex_service.rb

@@ -9,10 +9,7 @@ module Please
         client = ::OpenAI::Client.new(access_token: access_token)
 
         response = client.completions(
-          engine: 'davinci-codex',
-          parameters: default_parameters.merge(
-            prompt: prompt,
-          ),
+          parameters: default_parameters.merge(prompt: prompt),
         )
 
         response.parsed_response.fetch('choices').first.fetch('text')
@@ -22,6 +19,7 @@ module Please
 
       def default_parameters
         {
+          model: 'code-davinci-002',
           temperature: 0,
           max_tokens: 512,
           top_p: 1,

data/lib/please/request.rb

@@ -8,7 +8,7 @@ module Please
         # Collapse multiline commands into one line
         .gsub(/\s*\\\n\s*/, ' ')
         # Remove subsequent lines that do not contain commands
-        .gsub(/\n[^\$][^\n]*$/, '')
+        .gsub(/\n[^$][^\n]*$/, '')
         # Collapse multiple commands into one line
         .gsub(/\n\$ /, '; ')
         # Remove multiple consecutive spaces
@@ -19,7 +19,7 @@ module Please
       <<~PROMPT.chomp
         Write a one-line bash command for each of the following tasks.
 
-        #{context.to_s}
+        #{context}
 
         # #{instruction.gsub(/\n/, " ")}
         $

data/lib/please/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Please
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/please.gemspec

@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency 'ruby-openai', '>= 1.3'
-  spec.add_dependency 'tty-prompt', '>= 0.23'
+  spec.add_dependency 'ruby-openai', '~> 3.0'
+  spec.add_dependency 'tty-prompt', '~> 0.23'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: openai-please
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Joe Anderson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2023-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.23'
 description: 
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Convert natural language to bash commands using OpenAI Codex