fli_video 0.0.2 → 0.1.1

data/README.md

@@ -2,6 +2,8 @@
 
 > FliVideo - Video Asset Management for Content Creators
 
+GPT Link: https://chatgpt.com/c/dd1f4202-a449-45a6-af45-b65d8e544685
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,13 +24,21 @@ Or install it yourself as:
 gem install fli_video
 ```
 
-## Stories
+## Documentation
+
+### Technical Design Document
+
+The main design document is located here: [Technical Specification](docs/technical-specifications.md)
+
+### Feature List
+
+List of features that are planned for this project: [Feature List](docs/feature-list.md)
 
 ### Main Story
 
 As a content creator, I want to create quality videos quickly, so that I can build my YouTube influence
 
-See all [stories](./STORIES.md)
+See all [stories](./stories.md)
 
 
 ## Usage
@@ -36,7 +46,6 @@ See all [stories](./STORIES.md)
 See all [usage examples](./USAGE.md)
 
 
-
 ## Development
 
 Checkout the repo
@@ -49,25 +58,9 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-```bash
-bin/console
-
-Aaa::Bbb::Program.execute()
-# => ""
-```
-
-`fli_video` 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.
-
-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).
-
-```bash
-rake publish
-rake clean
-```
-
 ## Git helpers used by this project
 
-Add the follow helpers to your `alias` file
+Add the follow helpers to your `alias` file so that you can use Semantic Commits and have them automatically pushed to GitHub and have the CI/CD pipeline run.
 
 ```bash
 function kcommit()

data/bin/fli_video

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/fli_video/cli'
+
+FliVideo::CLI.start(ARGV)

data/docs/feature-list.md

@@ -0,0 +1,76 @@
+## Features
+
+### Feature <-> DSL GPTs
+https://chat.openai.com/g/g-AyFi0UOXn-code-simplifier
+
+**Global Configuration**
+Access and apply global configuration settings for video asset management and state consistency.
+
+**Project Configuration**
+Access and apply video or episode settings and state. Infers project settings from existing project folders and files.
+
+**CLI Project Commands**
+Efficiently execute and manage video project commands using a command-line interface, enhancing control and flexibility in project handling.
+
+**FileWatch Processor**
+Utilize a FileWatch processor to automate file event responses, directing new recordings to designated folders for efficient content management.
+
+**Create Project**
+Setup a new video project for standalone YouTube video or Podcast.
+
+**Add Episode**
+Add a new episode to an existing podcast project.
+
+**Switch Video Focus**
+Easily switch between different video projects or episodes to accommodate changing content priorities.
+
+**Move eCamm File**
+Seamlessly transfer eCamm recordings to the current focused video or podcast episode recordings subfolder.
+
+**Project Path**
+Construct and manage project paths dynamically using configurable values and existing folder name segments.
+
+**Episode Path**
+Construct and manage episode paths dynamically using configurable values and existing folder name segments.
+
+**Recording Namer**
+Dynamically generate and update video recording filenames, incorporating chapter and part sequences, chapter names, and tags, with capabilities to modify chapter sequences and tags for improved organization and content identification.
+
+**Change Chapter Name**
+Alter the name of a chapter based on its sequence in the project, facilitating better organization and identification of video content.
+
+**Trash**
+Moves suboptimal video takes to a designated 'trash' or 'archive' folder, optimizing storage and maintaining project clarity by segregating lesser-quality content.
+
+**Trash Undo**
+Retrieves video takes from the '.trash' folder and moves them back into the target project folder, allowing for reconsideration or re-evaluation of previously discarded content.
+
+**Clean Trash**
+Permanently deletes video takes from the 'trash' or 'archive' folder, freeing up storage space and ensuring project clarity.
+
+**Open in Finder**
+Quickly access video project and episode folders within the Finder, streamlining file navigation.
+
+**Create Chapter Video**
+Combine and review video chapter segments independently, facilitating content evaluation and editing.
+
+**Text to Speech**
+Transcribe spoken content to text and store transcriptions folder in multiple transcription formats.
+
+Create a DSL using the interactor pattern for:
+
+**Transcript Data Store**
+Builds a JSON datastore of transcripts for an entire project based on existing transcript folders found within project, episode, recording, chapter and post-produced folders.
+
+**Project Meta Data Store**
+Build a JSON datastore of files for an entire project based on existing project, episode, recording, chapter and post-produced folders and infer metadata based on KEYWORDS, transcripts or other useful data.
+
+## Future Ideas
+
+**Web Command Interface for Video Project Management**
+Introduce a streamlined, web-based interface for managing video project commands, enabling efficient control and organization of project components through simple browser interactions.
+
+**Project Meta Report**
+Generate a detailed report for a specific video project, including the episodes, chapters, recordings, a list of recording IDs (chapter sequence + part sequence), and the name for the next video recording, file sizes.
+This should be extracted to an AstroJS Website or HTML template servered by a local webserver and provide viewing and navigation for all my video projects.
+

data/docs/generated/application-structure.json

@@ -0,0 +1,53 @@
+[
+  {
+    "name": "spec",
+    "type": "directory",
+    "children": [
+      {
+        "name": "spec_helper.rb",
+        "type": "file",
+        "content": "# frozen_string_literal: true\n\nrequire 'pry'\nrequire 'bundler/setup'\nrequire 'simplecov'\n\nSimpleCov.start\n\nrequire 'fli_video'\n\nRSpec.configure do |config|\n  # Enable flags like --only-failures and --next-failure\n  config.example_status_persistence_file_path = '.rspec_status'\n  config.filter_run_when_matching :focus\n\n  # Disable RSpec exposing methods globally on `Module` and `main`\n  config.disable_monkey_patching!\n\n  config.expect_with :rspec do |c|\n    c.syntax = :expect\n  end\nend\n"
+      },
+      {
+        "name": "fli_video_spec.rb",
+        "type": "file",
+        "content": "# frozen_string_literal: true\n\nRSpec.describe FliVideo do\n  it 'has a version number' do\n    expect(FliVideo::VERSION).not_to be_nil\n  end\nend\n"
+      }
+    ]
+  },
+  {
+    "name": "README.md",
+    "type": "file"
+  },
+  {
+    "name": "lib",
+    "type": "directory",
+    "children": [
+      {
+        "name": "fli_video",
+        "type": "directory",
+        "children": [
+          {
+            "name": "cli.rb",
+            "type": "file",
+            "content": "# frozen_string_literal: true\n\nrequire_relative '../fli_video'\n\nmodule FliVideo\n  # FliVideo::CLI is the command line interface for the FliVideo gem.\n  class CLI\n    def self.start(args)\n      new(args).execute\n    end\n\n    def initialize(args)\n      @args = args\n    end\n\n    def execute\n      if @args.empty?\n        puts 'FliVideo CLI - No command provided'\n        return\n      end\n\n      case @args.first\n      when 'version'\n        puts \"FliVideo version #{FliVideo::VERSION}\"\n      else\n        puts \"Unknown command: #{@args.first}\"\n      end\n    end\n  end\nend\n"
+          },
+          {
+            "name": "version.rb",
+            "type": "file",
+            "content": "# frozen_string_literal: true\n\nmodule FliVideo\n  VERSION = '0.1.0'\nend\n"
+          }
+        ]
+      },
+      {
+        "name": "fli_video.rb",
+        "type": "file",
+        "content": "# frozen_string_literal: true\n\nrequire_relative 'fli_video/version'\n\nmodule FliVideo\n  class Error < StandardError; end\n  # Your code goes here...\nend\n"
+      }
+    ]
+  },
+  {
+    "name": "Gemfile",
+    "type": "file"
+  }
+]