openai_pipe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bfeb3903a2ddaf5a0639611b797662f1f04a4884792d60b81b65a590660b84e3
+  data.tar.gz: c62e6fc90a1e5fcab6059e95abec5cd0bffa72c162c064147cc2f21aa6d49345
+SHA512:
+  metadata.gz: 6d93cf540037b54b3038ccae81f0cd6947b00895e562144aa1e55caff17f15226331a1aed1816821b704d161d3f2dd011fbaf86dd166bb986dd0a9a700eff56e
+  data.tar.gz: aa29f3738ebfc161d11283f79b2c0c1840a245edbebdfb8d120a35e9fa4376777ff603d540c4d3639e387ba3ba26de85cc8327ad1f68f2b51867733d4b721673

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-23
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in openai_pipe.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    openai_pipe (0.1.0)
+      quick_openai (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    dotenv (2.8.1)
+    down (5.3.1)
+      addressable (~> 2.8)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    json (2.6.3)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    quick_openai (0.1.0)
+      down (~> 5)
+      ruby-openai (~> 2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.41.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-openai (2.2.0)
+      dotenv (>= 2.7.6, < 2.9.0)
+      httparty (>= 0.18.1, < 0.21.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  openai_pipe!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 John DeSilva
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,181 @@
+# OpenAIPipe
+
+This library provides a UNIX-ey interface to OpenAI.
+See [Installation](#installation) and [Setup](#setup) below, but first, some examples.
+
+## Examples
+
+```console
+$ ai what is two plus two
+Two plus two is equal to four.
+```
+
+```console
+$ uptime | ai convert this to json
+{
+        "time_of_measurement": "13:48:26",
+        "up_time": "30 days, 18:07",
+        "users": 3,
+        "load_average": [
+                0.46,
+                0.61,
+                0.79
+        ]
+}
+```
+
+```console
+$ ai list the nine planets as JSON | ai convert this to XML but in French | tee planets.fr.xml
+<Planètes>
+   <Planète>Mercure</Planète>
+   <Planète>Vénus</Planète>
+   <Planète>La Terre</Planète>
+   <Planète>Mars</Planète>
+   <Planète>Jupiter</Planète>
+   <Planète>Saturne</Planète>
+   <Planète>Uranus</Planète>
+   <Planète>Neptune</Planète>
+   <Planète>Pluton</Planète>
+</Planètes>
+```
+
+```console
+$ curl -sL "https://en.wikipedia.org/wiki/cats" | head -n 5 | ai extract just the title of this webpage | figlet
+  ____      _            __        ___ _    _                _ _
+ / ___|__ _| |_          \ \      / (_) | _(_)_ __   ___  __| (_) __ _
+| |   / _` | __|  _____   \ \ /\ / /| | |/ / | '_ \ / _ \/ _` | |/ _` |
+| |__| (_| | |_  |_____|   \ V  V / | |   <| | |_) |  __/ (_| | | (_| |
+ \____\__,_|\__|            \_/\_/  |_|_|\_\_| .__/ \___|\__,_|_|\__,_|
+                                             |_|
+```
+
+```console
+$ ls | ai What is this directory for?
+This directory contains the source code for a Ruby-based project called openai_pipe. It includes files related to the project's license (LICENSE.txt), changelog (CHANGELOG.md), dependencies (Gemfile and Gemfile.lock), executables (bin and exe), libraries (lib), signature (sig) and tests (spec). There is also a Rakefile and a README.md file which provide information about how to build and install the project, as well as its features and usage. Finally, it includes the openai_pipe-0.1.0.gem and openai_pipe.gemspec files which are used to build the gem which can be installed on other systems.
+```
+
+```console
+$ ls -l | ai which of these are directories?
+bin, exe, lib, sig, spec
+```
+
+```console
+$ ls | ai "For each of these files, provide a description of what is likely to be their contents?"
+bin - Likely contains compiled binary executable files.
+CHANGELOG.md - Likely contains a log of changes/modifications, such as bug fixes and new features, that have been made to the project.
+exe - Likely contains executable files.
+french_planets.xml - Likely contains an XML file containing data related to planets, likely in French.
+Gemfile - Likely contains Ruby code for the project's dependencies.
+Gemfile.lock - Likely contains a snapshot of the dependencies of the project and versions of those dependencies.
+lib - Likely contains the Ruby source code (e.g. classes and modules) for the project.
+LICENSE.txt - Likely contains the terms of use/license for the project.
+openai_pipe-0.1.0.gem - Likely contains a gem that gathers information from the OpenAI API.
+openai_pipe.gemspec - Likely contains configuration details for the gem.
+planets.lst - Likely contains a list of planets.
+poem.txt - Likely contains a text file containing a poem.
+Rakefile - Likely contains Ruby tasks and dependencies that can be used in projects.
+README.md - Likely contains general information about the project and usage instructions.
+reverse.lst - Likely contains a list of words or items that are in reverse order.
+sig - Likely contains digital signatures to validate individual files.
+spec - Likely contains Ruby specs (i.e. tests) for the project.
+uptime.json - Likely contains a file with information regarding system uptime of a computer.
+```
+
+```console
+$ git commit -m "$(git status | ai write me a commit message for these changes)"
+[master 7d0271f] Add new files and modify README.md
+```
+
+```console
+$ git status | tee /dev/tty | ai write me a sonnet about the status of this git repository
+On branch master
+Untracked files:
+  (use "git add <file>..." to include in what will be committed)
+        openai_pipe-0.1.0.gem
+
+nothing added to commit but untracked files present (use "git add" to track)
+
+My master branch may lack to thee its kin
+For change it holds the only force within
+Thé untracked files, they still remain unnamed
+‘Tis fervent hope thé change will soon be claimed
+
+Fraught with the choice to leave or to persist
+The repository wavers ‘tween future and past
+The openai_pipe-0.1.0 gem stands out
+Waiting to be added, not yet about
+
+The commit awaits for brave new changes bold
+While time’s old force is ever unfurled
+Commit forth young mind, furrow not to crawl
+From untracked files, a future stands tall.
+```
+
+```console
+% history | ai what was the last thing I did
+The last command you entered was 'history'.
+```
+n.b. somehow it sees history-esque output and determines that history was typed -- the history command does not itself include the history command in the output.
+
+```console
+$ history | ai what was the last thing I did before typing history
+The last thing you did was amend a README.md file.
+```
+n.b. here it determines the amend was for README.md not from the previous command but from ones prior that edited README.md.
+
+```console
+$ cat lib/openai_pipe/version.rb | ai rewrite this file with just the minor version incremented | sponge > lib/openai_pipe/version.rb
+$ git diff
+diff --git a/lib/openai_pipe/version.rb b/lib/openai_pipe/version.rb
+index 0f82357..cc57fab 100644
+--- a/lib/openai_pipe/version.rb
++++ b/lib/openai_pipe/version.rb
+@@ -1,5 +1,5 @@
+ # frozen_string_literal: true
+
+ module OpenAIPipe
+-  VERSION = "0.1.0"
++  VERSION = "0.1.1"
+ end
+```
+
+```console
+$ ruby -e "$(ai write me a python script that prints the current month | ai translate this into ruby)" | ai translate this into French
+Le mois courant est Décembre.
+```
+
+## Installation
+
+Install the gem by executing:
+
+    $ gem install openai_pipe
+
+## Setup
+
+By default the executable is called `openai_pipe`. It is reccommended to alias this command to something shorter in .bashrc or equivalent, e.g.
+```bash
+alias ai="openai_pipe"
+```
+
+You will also need to have your OpenAI access token in ENV, so also in .bashrc or equivalent,
+```bash
+export OPENAI_ACCESS_TOKEN=mytoken
+```
+
+## Notes
+
+Be aware that there is a cost associated every time GPT3 is invoked, so be mindful of your account usage. Also be wary of sending sensitive data to OpenAI, and also wary of arbitrarily executing scripts or programs that GPT3 generates.
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Aesthetikx/openai_pipe.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/openai_pipe

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "openai_pipe"
+
+OpenAIPipe.exe

data/lib/openai_pipe/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OpenAIPipe
+  VERSION = "0.1.0"
+end

data/lib/openai_pipe.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "openai_pipe/version"
+
+require "quick_openai"
+
+module OpenAIPipe
+  class Error < StandardError; end
+
+  def self.exe
+    input_from_pipe = $stdin.read if $stdin.stat.pipe?
+
+    input_from_arguments = ARGV.join(" ") if ARGV.any?
+
+    prompt = [input_from_arguments, input_from_pipe].compact.join("\n\n")
+
+    puts prompt.gpt3
+  rescue QuickOpenAI::Error => e
+    warn e.message
+    exit 1
+  end
+end

data/sig/openai_pipe.rbs

@@ -0,0 +1,4 @@
+module OpenaiPipe
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: openai_pipe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John DeSilva
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: quick_openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Provides pipe and redirect functionality to quick_openai
+email:
+- desilvjo@umich.edu
+executables:
+- openai_pipe
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/openai_pipe
+- lib/openai_pipe.rb
+- lib/openai_pipe/version.rb
+- sig/openai_pipe.rbs
+homepage: https://www.github.com/Aesthetikx/openai_pipe
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/Aesthetikx/openai_pipe
+  source_code_uri: https://www.github.com/Aesthetikx/openai_pipe
+  changelog_uri: https://www.github.com/Aesthetikx/openai_pipe/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A UNIX-ey interface to OpenAI
+test_files: []