openai_101 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf7d69814faceeb10dc8529eab3e644ea1c8cc7814fa9c760b88d332d9f56a02
-  data.tar.gz: ceb5b93d49096126df3875dd541bc3d40081bdca051770ceb132ac9995f3a4a6
+  metadata.gz: d33410818e89daeeb9011d5a75ed0063fb91fe86c6d5f7a3ab792fc2017d45c0
+  data.tar.gz: 6ffeba5c3a534647b3fa05835086cf5fdc481c296962795f60880b26415a2626
 SHA512:
-  metadata.gz: 8505915867b4bb48f980c0a2a5c343da0d0c07aac17e97c2e29e9d6a96c00e252dad64d43015c9c54ba40c347d2db863fc0d5f3b35cb534793ea320f0f5b6f88
-  data.tar.gz: c38ca4102babd07dbce6765180734e0e4aff4a58b1fd80e8a41e58570ca55633cab109491755135e7a993a98aa8e5ef65a8b833f8a1a98f7229de066db6969c8
+  metadata.gz: a3403d3d15af8f001c6056c1d120ab3f683854cef5d2cec1275d88a4edfb96a4342bb6cd836d86b9451d571e4324e9b9313d9be56f11c1c582b52204d932fb03
+  data.tar.gz: c624cd17e5603d40c30e13a7753243a3882dd3f1e592e84935eb1b9b46b3edb7be715af15d198f95c6af9241a4d49fa064828f0477625d2b2a51efeae5de179a

data/.releaserc.json

@@ -36,5 +36,5 @@
     ],
     "@semantic-release/github"
   ],
-  "repositoryUrl": "git@github.com:appydave/openai_101.git"
+  "repositoryUrl": "git@github.com:klueless-io/openai_101.git"
 }

data/.rubocop.yml

@@ -7,13 +7,14 @@ require:
   - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.2
   DisplayCopNames: true
   ExtraDetails: true
   NewCops: enable
   Exclude:
     - ".builders/**/*"
     - "spec/samples/**/*"
+    - "spec/openai_101/tools/**/*"
 
 Metrics/BlockLength:
   Exclude:
@@ -39,8 +40,22 @@ Metrics/BlockLength:
     - shared_examples_for
     - transaction
 
-Metrics/MethodLength:
+Metrics/AbcSize:
   Max: 25
+  Exclude:
+    - "lib/openai_101/tools/edl_to_chapters.rb"
+    - "lib/openai_101/tools/clean_ruby_errors.rb"
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - "lib/openai_101/tools/clean_ruby_errors.rb"
+
+Metrics/MethodLength:
+  Exclude:
+    - "lib/openai_101/tools/edl_to_chapters.rb"
+    - "lib/openai_101/tools/clean_ruby_errors.rb"
+    - "lib/openai_101/tools/sanitize_all_webp_files"
+    - "lib/openai_101/tools/webp_to_png.rb"
 
 Layout/LineLength:
   Max: 200
@@ -95,12 +110,14 @@ Layout/SpaceBeforeComma:
 RSpec/NestedGroups:
   Max: 5
 
-RSpec/SpecFilePathFormat:
-  Enabled: true
-
-RSpec/SpecFilePathSuffix:
-  Enabled: true
+RSpec/FilePath:
+  Exclude:
+    - "**/spec/**/*"
 
 RSpec/NamedSubject:
   Exclude:
     - "**/spec/**/*"
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/openai_101/config/openai_spec.rb'

data/.tool-versions

@@ -1 +1 @@
-ruby 3.3.3
+ruby 3.2.2

data/CHANGELOG.md

@@ -1,12 +1,19 @@
-# [0.1.0](https://github.com/appydave/openai_101/compare/v0.0.1...v0.1.0) (2024-06-19)
+## [0.0.2](https://github.com/klueless-io/openai_101/compare/v0.0.1...v0.0.2) (2024-02-08)
 
 
-### Features
+### Bug Fixes
 
-* moved repo to appydave organization ([3b01048](https://github.com/appydave/openai_101/commit/3b01048e2e0f381a6ab5bc0a7cfb4cedd83da88f))
+* namespace issue ([cbcbeb8](https://github.com/klueless-io/openai_101/commit/cbcbeb80c204954a1cfb6db4102e9acaa6844a52))
+* ruby 2.7 & 3.2 ([0af05e1](https://github.com/klueless-io/openai_101/commit/0af05e1e0e99bf08ebc4e7396bd55d10005d25e8))
+* ruby 3.2 only ([d9c463a](https://github.com/klueless-io/openai_101/commit/d9c463a2775efd19d88e4d73402392fbe8c42d01))
+* semantic release 19 ([c123a3f](https://github.com/klueless-io/openai_101/commit/c123a3f9cfa85dfa96769e38ea9f98b84cf94156))
+* semantic release 19 ([e5251b1](https://github.com/klueless-io/openai_101/commit/e5251b1a8ac102533fb9253f8ffb1676c86e385d))
+* semantic release 21 ([62ba587](https://github.com/klueless-io/openai_101/commit/62ba5870dabfe24c150943cdcd62e1a24c53a885))
+* update ruby version ([142cff3](https://github.com/klueless-io/openai_101/commit/142cff346b41aac6e8b6083f970a03c1681c23ad))
+* update ruby version ([f378f52](https://github.com/klueless-io/openai_101/commit/f378f520a8578372834ec57bdf6b2f4b16be813c))
 
 ## [Unreleased]
 
-## [0.1.0] - 2024-06-19
+## [0.1.0] - 2024-02-09
 
 - Initial release

data/README.md

@@ -1,6 +1,22 @@
+DAVID: Check this out, should add it into the openAI course:
+
+https://www.loom.com/share/117eb552f1974f3d8e28463e9f1809e1
+
+Based on:
+
+https://innovate-aiml-data-apj.virtual.awsevents.com/media/10.%20Codenator%3A%20Enhancing%20user%20productivity%20through%20AI-powered%20code%20generation%20and%20secure%20execution/1_0kzrwmxu/330865472
+
+
+
 # Openai 101
 
-> OpenAI 101 working through the API endpoints
+> OpenAI 101 Series on using OpenAI ChatGPT, DALL·E, and other OpenAI endpoints
+
+**Focus Story**
+
+As a software developer, I want to understand OpenAI endpoints and capabilities, so that I can use ChatGPT effectively
+
+
 
 ## Installation
 
@@ -22,76 +38,84 @@ Or install it yourself as:
 gem install openai_101
 ```
 
-## Stories
+## JavaScript Dependencies Installation
 
-### Main Story
+This optional step is only required if you plan to use the JavaScript tools included in this gem from the command line.
 
-As a Developer, I want to understand openai/chatgpt APIs, so that I can build AI applications effectively
+[Javascript Tools]
 
-See all [stories](./STORIES.md)
+This gem includes tools written in JavaScript, requiring Node.js and associated packages. After installing the gem, navigate to the gem's root directory and run:
 
+```bash
+npm install
+```
 
-## Usage
+## Resources
 
-See all [usage examples](./USAGE.md)
+- [Course Outline](./COURSE.md)
+- [OpenAI Documentation](gpt-context/openai-documentation.md) is used as reference material for code generation prompts, this information has been summarized from source documentation
+- [Ruby OpenAI Documentation](gpt-context/ruby-openai-documenation.md) is used as reference material for code generation prompts and shows examples of how to use the Ruby OpenAI gem
 
 
+See all [stories](./STORIES.md)
 
 ## Development
 
 Checkout the repo
 
 ```bash
-git clone https://github.com/appydave/openai_101
+git clone https://github.com/klueless-io/openai_101
 ```
 
 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.
 
-```bash
-bin/console
+## Command line tools
 
-Aaa::Bbb::Program.execute()
-# => ""
-```
+### Bulk MidJourney Image Generation
 
-`openai_101` is setup with Guard, run `guard`, this will watch development file changes and run tests automatically, if successful, it will then run rubocop for style quality.
+Automates MidJourney prompts on Discord.
 
-To release a new version, update the version number in `version.rb`, build the gem and push the `.gem` file to [rubygems.org](https://rubygems.org).
+`automate-images-midjourney`
 
-```bash
-rake publish
-rake clean
-```
+This tool will read prompts from a file and then paste them into the MidJourney Discord channel in an unattented manner. This is useful for automating the process of generating images from prompts in bulk. NOTE: You start the script and then you place the cursor in the Discord channel and the script will do the rest.
+
+### Bulk ChatGPT Image Generation
+
+Automates image prompts in ChatGPT.
+
+`automate-images-chatgpt`
+
+This tool will read prompts from a file and then paste them into the current focused ChatGPT window in unattented mode. This is useful for automating the process of generating images from prompts in bulk using the DALE-3 feature in ChatGPT Plus. NOTE: You start the script and then you place the cursor in the ChatGPT window and the script will do the rest.
 
-## Git helpers used by this project
+### WEBP to PNG Converter:
 
-Add the follow helpers to your `alias` file
+Converts WEBP images to PNG, manages prompts.
 
+`web3_to_png`
+
+### EDL to Chapters
+
+Converts EDL time codes to chapters in YouTube video description.
+
+`edl_to_chapters`
+
+Usage on Mac
 ```bash
-function kcommit()
-{
-  echo 'git add .'
-  git add .
-  echo "git commit -m "$1""
-  git commit -m "$1"
-  echo 'git pull'
-  git pull
-  echo 'git push'
-  git push
-  sleep 3
-  run_id="$(gh run list --limit 1 | grep -Eo "[0-9]{9,11}")"
-  gh run watch $run_id --exit-status && echo "run completed and successful" && git pull && git tag | sort -V | tail -1
-}
-function kchore     () { kcommit "chore: $1" }
-function kdocs      () { kcommit "docs: $1" }
-function kfix       () { kcommit "fix: $1" }
-function kfeat      () { kcommit "feat: $1" }
-function ktest      () { kcommit "test: $1" }
-function krefactor  () { kcommit "refactor: $1" }
+# make the script executable
+chmod +x bin/convert_webp_to_png.rb
+
+# run the script
+./bin/convert_webp_to_png.rb -s path/to/source -t path/to/target -f target_filename -p optional_prefix
+
+# Example
+./bin/convert_webp_to_png.rb -p series-2  -f woman-grey-tabby-cat -s /Users/davidcruwys/Sync/smart-downloads/download-images
+ -t /Volumes/Expansion/Sync/tube-channels/a-cast/cast-active/a35-automate-image-generation/assets
 ```
 
+This tool automates the conversion of WEBP images to PNG format, stores associated prompts, manages source backups, and cleans up after processing.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/klueless-io/openai_101. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/bin/automate-chatgpt.js

@@ -0,0 +1,60 @@
+const { Command } = require('commander');
+const fs = require('fs');
+const robot = require("robotjs");
+
+const program = new Command();
+
+program
+  .option('-f, --file <filename>', 'The file to read prompts from', 'prompts.txt')
+  .option('-o, --completed-file <filename>', 'The file to write completed prompts to', 'completed.txt')
+  .option('-i, --interval <seconds>', 'The interval in seconds between prompts', 80)
+  .option('-m, --max-images <number>', 'The maximum number of images to process', 20);
+
+program.parse(process.argv);
+
+function read_prompts_from_file(file, maxImages) {
+  const prompts = fs.readFileSync(file, 'utf-8').split('\n').filter(Boolean);
+  return prompts.slice(0, maxImages);
+}
+
+function remove_prompt_from_file(file, prompt) {
+  const prompts = fs.readFileSync(file, 'utf-8').split('\n').filter(Boolean);
+  const index = prompts.indexOf(prompt);
+  if (index !== -1) {
+    prompts.splice(index, 1);
+    fs.writeFileSync(file, prompts.join('\n'));
+  }
+}
+
+function append_prompt_to_file(file, prompt) {
+  fs.appendFileSync(file, `${prompt}\n`);
+}
+
+function wait(ms) {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+async function send_prompt_to_chat(prompt) {
+  const formattedPrompt = `create image: ${prompt}`;
+  robot.typeString(formattedPrompt);
+  robot.keyTap('enter');
+}
+
+async function start() {
+  console.log('Starting Image Creation Automation');
+  console.log('Please open the ChatGPT interface where you intend to use this script.');
+  console.log('Automation will begin in 10 seconds.');
+  await wait(10000);
+
+  const prompts = read_prompts_from_file(program.opts().file, parseInt(program.opts().maxImages));
+  for (let prompt of prompts) {
+    console.log(`Sending prompt "${prompt}"...`);
+    await send_prompt_to_chat(prompt);
+    await wait(program.opts().interval * 1000);
+    remove_prompt_from_file(program.opts().file, prompt);
+    append_prompt_to_file(program.opts().completedFile, prompt);
+  }
+  console.log('Automation complete.');
+}
+
+start();

data/bin/automate-midjourney.js

@@ -0,0 +1,75 @@
+const { Command } = require('commander');
+const fs = require('fs');
+const robot = require("robotjs");
+
+const program = new Command();
+
+program
+  .option('-f, --file <filename>', 'The file to read prompts from', 'prompts.txt')
+  .option('-o, --completed-file <filename>', 'The file to write completed prompts to', 'completed.txt')
+  .option('-i, --interval <seconds>', 'The interval in seconds between prompts', 4)
+  .option('-p, --prompts-per-session <prompts>', 'The number of prompts to process in a session', 7)
+  .option('-w, --wait-between-sessions <seconds>', 'The number of seconds to wait between sessions', 180);
+
+program.parse(process.argv);
+
+function read_next_prompt_from_file(file) {
+  const prompts = fs.readFileSync(file, 'utf-8').split('\n').filter(Boolean);
+  return prompts.shift();
+}
+
+function remove_prompt_from_file(file, prompt) {
+  const lockfile = `${file}.lock`;
+  fs.writeFileSync(lockfile, '', { flag: 'wx' });
+  const prompts = fs.readFileSync(file, 'utf-8').split('\n').filter(Boolean);
+  const index = prompts.indexOf(prompt);
+  prompts.splice(index, 1);
+  fs.writeFileSync(file, prompts.join('\n'));
+  fs.unlinkSync(lockfile);
+}
+
+function append_prompt_to_file(file, prompt) {
+  const lockfile = `${file}.lock`;
+  fs.writeFileSync(lockfile, '', { flag: 'wx' });
+  fs.appendFileSync(file, `${prompt}\n`);
+  fs.unlinkSync(lockfile);
+}
+
+function wait(ms) {
+  const end = Date.now() + ms;
+  while (Date.now() < end) {
+    // Wait
+  }
+}
+
+function send_prompt_to_discord(prompt) {
+  const formattedPrompt = `/imagine prompt: ${prompt}`;
+  robot.typeString(formattedPrompt);
+  robot.keyTap('enter');
+}
+
+function start() {
+  console.log('Starting MidJourney Automation');
+  console.log('Please open Discord and navigate to the MidJourney channel.');
+  console.log('Automation will begin in 10 seconds.');
+  wait(10 * 1000);
+
+  let index = 0;
+  let prompt = read_next_prompt_from_file(program.opts().file);
+  while (prompt) {
+    console.log(`Sending prompt "${prompt}"...`);
+    send_prompt_to_discord(prompt);
+    wait(program.opts().interval * 1000);
+    remove_prompt_from_file(program.opts().file, prompt);
+    append_prompt_to_file(program.opts().completedFile, prompt);
+    index++;
+    if (index % program.opts().promptsPerSession === 0) {
+      console.log(`Pausing for ${program.opts().waitBetweenSessions} seconds.`);
+      wait(program.opts().waitBetweenSessions * 1000);
+    }
+    prompt = read_next_prompt_from_file(program.opts().file);
+  }
+  console.log('Automation complete.');
+}
+
+start();

data/bin/convert_webp_to_png.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pry'
+require 'optparse'
+require_relative '../lib/openai_101/tools/webp_to_png'
+
+options = {
+  prefix: nil,
+  debug: false,
+  dry_run: false
+}
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: convert_webp_to_png.rb [options]'
+
+  opts.on('-s', '--source=SOURCE', 'Source directory containing WEBP files') do |source|
+    options[:source_folder] = source
+  end
+
+  opts.on('-t', '--target=TARGET', 'Target directory for PNG files') do |target|
+    options[:target_folder] = target
+  end
+
+  opts.on('-f', '--filename=FILENAME', 'Specific target filename for the PNG output') do |filename|
+    options[:target_filename] = filename
+  end
+
+  opts.on('-p', '--prefix=PREFIX', 'Optional prefix for the target filename') do |prefix|
+    options[:prefix] = prefix
+  end
+
+  opts.on('-d', '--debug', 'Enable debug mode') do
+    options[:debug] = true
+  end
+
+  opts.on('--dry-run', 'Simulate the conversion process without making any changes') do
+    options[:dry_run] = true
+  end
+
+  opts.on('-h', '--help', 'Prints this help') do
+    puts opts
+    exit
+  end
+end.parse!
+
+unless options[:target_filename]
+  puts 'A target filename is required.'
+  exit
+end
+
+converter = Openai101::Tools::WebpToPng.new(
+  source_folder: options[:source_folder],
+  target_folder: options[:target_folder],
+  target_filename: options[:target_filename],
+  prefix: options[:prefix]
+)
+
+if options[:debug]
+  puts "Source folder       : #{converter.source_folder}"
+  puts "Target folder       : #{converter.target_folder}"
+  puts "Target filename     : #{converter.target_filename}"
+  puts "Source filename     : #{converter.source_filename}"
+  puts "Prefix              : #{converter.prefix}"
+  puts "Target prompt       : #{converter.prompt}"
+  puts "Target PNG file     : #{converter.target_png_file}"
+  puts "Target Prompt file  : #{converter.target_prompt_file}"
+end
+
+if options[:dry_run]
+  puts 'Dry run enabled - no changes will be made.'
+  exit
+end
+
+converter.sanitize_all_webp_files
+
+if converter.source?
+  converter
+    .convert
+    .store_prompt
+    .backup_source
+    .delete_source
+  puts 'Conversion and processing complete.'
+else
+  puts "\e[31mNo source file found\e[0m"
+end

data/bin/gpt_context_gatherer.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Usage:
+#   ./bin/gpt_context_gatherer.rb -d -i 'lib/openai_101/tools/**/*.rb'
+#   ./bin/gpt_context_gatherer.rb -d -i 'lib/openai_101/tools/**/*' -e 'node_modules/**/*' -e 'package-lock.json' -e 'lib/openai_101/tools/prompts/*.txt'
+#
+#   Get GPT Context Gatherer code
+#   ./bin/gpt_context_gatherer.rb -i 'bin/**/*gather*.rb' -i 'lib/openai_101/tools/**/*gather*.rb'
+require 'optparse'
+require 'clipboard'
+require_relative '../lib/openai_101/tools/file_content_gatherer'
+
+options = {
+  include_patterns: [],
+  exclude_patterns: [],
+  debug: false
+}
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: gather_content.rb [options]'
+
+  opts.on('-i', '--include PATTERN', 'Pattern or file to include (can be used multiple times)') do |pattern|
+    options[:include_patterns] << pattern
+  end
+
+  opts.on('-e', '--exclude PATTERN', 'Pattern or file to exclude (can be used multiple times)') do |pattern|
+    options[:exclude_patterns] << pattern
+  end
+
+  opts.on('-d', '--debug', 'Enable debug mode') do
+    options[:debug] = true
+  end
+
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    puts "\nExamples:"
+    puts "  #{File.basename($PROGRAM_NAME)} -i 'lib/**/*.rb' -e 'lib/excluded/**/*.rb' -d"
+    puts "  #{File.basename($PROGRAM_NAME)} --include 'src/**/*.js' --exclude 'src/vendor/**/*.js'"
+
+    puts ''
+    puts '  # Get GPT Context Gatherer code that is found in any folder (bin, lib & spec)'
+    puts "  #{File.basename($PROGRAM_NAME)} -i '**/*gather*.rb'"
+    exit
+  end
+end.parse!
+
+pp options if options[:debug]
+
+gatherer = Openai101::Tools::FileContentGatherer.new(
+  include_patterns: options[:include_patterns],
+  exclude_patterns: options[:exclude_patterns]
+)
+
+content = gatherer.build
+
+if options[:debug]
+  puts '-' * 80
+  puts content
+  puts '-' * 80
+end
+
+Clipboard.copy(content)

data/course/course.md

@@ -0,0 +1,64 @@
+# OpenAI 101
+
+> OpenAI 101 Series on using OpenAI ChatGPT, DALL·E, and other OpenAI endpoints
+
+As a software developer, I want to understand OpenAI endpoints and capabilities, so that I can use ChatGPT effectively
+
+## Overview
+
+Compreshensive guide to using OpenAI endpoints and capabilities, in this section we will look at the building blocks for this series and what we plan to cover.
+
+- [Built On](#built-on)
+- [Hello World](#achieving-hello-world-status)
+  - Configure OpenAI API
+
+
+## Built On
+
+- Ruby Gem (Library)
+- Dependencies
+  - `dotenv` for environment variables
+  - `ruby-openai` for OpenAI API
+- Tools
+  - `convert_webp_to_png` for converting ChatGPT images from WebP to PNG
+  - `automate-images-chatgpt` for running bulk image creation in ChatGPT/DALL·E
+  - `automate-images-midjourney` for running bulk image creation in MidJourney
+  - `edl_to_chapters` for converting EDL time codes to chapters in YouTube video description
+
+- GPT Context Documents
+  - OpenAI documentation
+  - Ruby OpenAI documentation
+
+## Achieving Hello World Status
+
+- Configure OpenAI API
+  - Create an account
+  - Create an API key
+  - Add API key to `.env` file
+  - Load `.env` file
+  - Use API key to authenticate with OpenAI API
+- Make first simple prompt request
+  - text completion
+- Models are Sexy
+  - Model list
+
+## What we will cover infographic
+
+TODO: Add infographic
+
+Notes:
+
+- List of endpoints
+- List of usecases
+  - 2nd Brain
+    - GPT Context used for code generation
+  - Code Generation
+  - Text to Image
+  - Image to Text (Vision)
+  - Text to Speech
+  - Speech to Text
+- Samples in 4 languages (GPT as a Polyglot Developer)
+  - Ruby
+  - Python
+  - JavaScript
+  - REST API (cURL)

data/course/images/prompts/beautiful-llm-models.txt

@@ -0,0 +1 @@
+A mystical illustration depicting three beautiful women representing large language models, set in an environment inspired by Pocahontas. Each woman

data/course/images/prompts/series-2-appydave-gpt-summit.txt

@@ -0,0 +1 @@
+An_image_of_a_computer_nerd__characterized_by_glasses_and_casual_tech-themed_attire__standing_confidently_on_a_stage._The_backdrop_is_a_large_screen_d