md2slides 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4a24667a8575a6e6cde9c235ef8647891bab980c81f17a346d3b8e292fce32d
-  data.tar.gz: 5b26d1ce769583990de6ede00e0647ae2fea46e4f352a352e2db740ef14964c6
+  metadata.gz: b7ead7e0a1d48738b1f88a039ec73924afcab9eb35ea0a3bf15f6933d655690e
+  data.tar.gz: dfe7efa2cc63e30e8c71dc15c74b784725e812fed5dd619034393f4dd97bc772
 SHA512:
-  metadata.gz: 4dbe7420d2a68f51fb381674e228e7c99cc7c1afbd5aba195355c93a50031c31f8ccdb443eb21d817892c9800e916a3198fd29a36855db0e8f46866da3263ac7
-  data.tar.gz: 97390985806cf9a63ac0543ce8e5f88362b48138fc3ffe26b819ff7b758dc49a2dfcfadb455995ac6ec1ef54b271c2b73303d898a38af1b42fe869bff235e572
+  metadata.gz: 33410bc7876fcb1b24f24628d73a66a3d5314cb34b6a9460301b68c95fc22e5e2ce6677559f66eebff3df6d4742f148ab91007dfe63de4f56e08b2009c780050
+  data.tar.gz: bbed92243410bd696a193a4859e9076590690946662b29c792ef6bec9b5c33e68adc8fd5c760b0490019cc2a17226b0911ba2bc96a06811f0447d287c41abb7c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+#/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# vi file.
+*.swp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in md2slides.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2025, Motoyuki OHMORI <ohmori@tottori-u.ac.jp>
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,91 @@
+# md2slides
+*md2slides* generates a Google presentation from a markdown file.
+A video file of a presentation will be also generated, and it may contains narration if supplied.
+Narration can be given as notes in slides, and the audio will be generated using Google text-to-speech API and ffmpeg.
+
+## Quick start
+1. Generate your Google API credentials and copy it to credentails.json:
+```
+% mkdir ~/.config/gcloud
+% cat >> ~/.config/gcloud/credentials.json
+{
+  "type": "service_account",
+  "project_id": "project-id",
+  "private_key_id": "private-key-ID',
+  "private_key": "-----BEGIN PRIVATE KEY-----\nhogehoge\n-----END PRIVATE KEY-----\n",
+  "client_email": "hogehoge@hogehoge.iam.gserviceaccount.com",
+  "client_id": "00000000000000000000",
+  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+  "token_uri": "https://oauth2.googleapis.com/token",
+  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/CLIENT.iam.gserviceaccount.com"
+}
+^D (this means CTRL + D)
+```
+2. install ffmpeg if necessary (if producing video file).
+
+3. install necessary gems.
+```
+% bundle install --path vendor/bundle
+```
+
+4. create an empty Google slide.
+
+5. write a markdown file.
+```
+cat >> doc/sample.md
+---
+title: hogehoge
+url: <Google presentation URL>
+---
+# title of the first title page
+## sub title or author's name(s)
+<!--
+narration text...
+-->
+---
+# title of the page
+- hogehoge
+...
+<!--
+narration text...
+-->
+^D (this means CTRL + D)
+```
+
+6. execute.
+```
+bundle exec bin/md2slides doc/sample.md
+```
+
+7. the Google presentation is updated, and the video is stored in the current directory.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'md2slides'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install md2slides
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 tags, 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/ohmori7/md2slides.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/TODO.md

@@ -0,0 +1,25 @@
+# TODO
+- abstraction of presentation elements
+- PDF output
+- character emphasis
+- indentation
+- itemization
+- enumeration
+- theme
+- page number
+- multi column
+- image
+- table
+- other floating object
+- generate a markdown file from an existing presentation file
+- incremental updates
+- other a presentation format such as Microsoft PowerPoint
+- move to google new API:
+	*******************************************************************************
+	The google-gax gem is officially end-of-life and will not be updated further.
+	
+	If your app uses the google-gax gem, it likely is using obsolete versions of
+	some Google Cloud client library (google-cloud-*) gem that depends on it. We
+	recommend updating any such libraries that depend on google-gax. Modern Google
+	Cloud client libraries will depend on the gapic-common gem instead.
+	*******************************************************************************

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "md2slides"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/text2mp3

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+# Copyright (c) 2025 Motoyuki OHMORI All rights reserved.
+
+$:.unshift File.join(File.dirname(File.realpath(__FILE__)), '..', 'lib')
+
+require 'presentation'
+
+def usage(errmsg = nil)
+	puts "ERROR: #{errmsg}" if errmsg
+	puts <<~EOF
+Usage:
+	#{$progname} [-f] <file>
+	#{$progname} -h
+
+Description:
+	create a voice from a text using Google Text-To-Speech API.
+
+Argument:
+	-h:	output this message.
+
+BUGS:
+	only .txt is allowed for an input file for now.
+
+	EOF
+	exit 1
+end
+
+v = ARGV.shift
+case v
+when '-h'
+	usage
+when nil
+	usage
+end
+ifile = v
+filename = Presentation::text_to_speech(File.read(ifile), ifile)
+puts "save to #{filename}"

data/lib/md2slides/audio.rb

@@ -1,4 +1,7 @@
 class Presentation
+	# XXX: Google Text to Speech produces at this rate...
+	AUDIO_RATE = 24000
+
 	def generate_audio0(i, slide, dir)
 		print "slide \##{i + 1}: generating audio... "
 		notes = get_slide_note(slide)
@@ -13,14 +16,13 @@ class Presentation
 			#
 			heading_silence = 2
 			trailing_silence = 1
-			audiorate = 24000
 			cmd = <<~CMD
 				ffmpeg -hide_banner -y				\
 				    -f lavfi -t #{heading_silence}		\
-				    -i anullsrc=r=#{audiorate}:cl=mono		\
+				    -i anullsrc=r=#{AUDIO_RATE}:cl=mono		\
 				    -i #{opath}					\
 				    -f lavfi -t #{trailing_silence}		\
-				    -i anullsrc=r=#{audiorate}:cl=mono		\
+				    -i anullsrc=r=#{AUDIO_RATE}:cl=mono		\
 				    -filter_complex "[0:a][1:a][2:a]concat=n=3:v=0:a=1[out]"	\
 				    -map "[out]"				\
 				    -c:a aac -b:a 64k #{path}

data/lib/md2slides/presentation.rb

@@ -356,9 +356,7 @@ class Presentation
 	end
 
 	def __data_path(basedir)
-		if basedir.nil?
-			basedir = File.join(BASEDIR, 'data')
-		end
+		basedir = '.' if basedir.nil?
 		title, subtitle = get_title
 		title = self.class.filename_sanitize(title)
 		subtitle = self.class.filename_sanitize(subtitle)

data/lib/md2slides/version.rb

@@ -0,0 +1,3 @@
+module Md2slides
+	VERSION = "0.0.3"
+end

data/lib/md2slides/video.rb

@@ -6,9 +6,6 @@ class Presentation
 		audio = __data_slide_path(i, '.m4a', dir)
 		video = __data_slide_path(i, '.mp4', dir)
 
-		# XXX: Google Text to Speech produces this...
-		audiorate = 24000
-
 		if File.exists?(audio)
 			audioin = "-i \"#{audio}\""
 			timeopt = '-shortest'
@@ -21,7 +18,7 @@ class Presentation
 			    -framerate 15 -loop 1 -i "#{img}"		\
 			    #{audioin} -map 0:v:0 -map 1:a:0		\
 			    -c:v libx264 -tune stillimage		\
-			    -c:a aac -ar #{audiorate} -ac 1		\
+			    -c:a aac -ar #{AUDIO_RATE} -ac 1		\
 			    -pix_fmt yuv420p #{timeopt} "#{video}"
 		CMD
 		msg, errmsg, status = Open3.capture3(cmd)
@@ -39,13 +36,13 @@ class Presentation
 		end
 
 		print "concatenate video files..."
-		videolist = File.join(dir, 'video-list.txt')
-		File.open(videolist, 'w') do |f|
+		videolist = 'video-list.txt'
+		File.open(File.join(dir, videolist), 'w') do |f|
 			@presentation.slides.each_with_index do |slide, i|
 				f.puts("file #{__data_slide_path(i, '.mp4')}")
 			end
 		end
-		video = File.join(dir, 'video.mp4')
+		video = 'video.mp4'
 		cmd = <<~CMD
 			cd "#{dir}" &&					\
 			    ffmpeg -hide_banner -y -f concat -safe 0	\

data/lib/md2slides.rb

@@ -1,7 +1,15 @@
 $:.unshift File.dirname(File.dirname(File.realpath(__FILE__)))
-require 'config/config'
-require 'md2slides/md'
-require 'md2slides/presentation'
-require 'md2slides/text_to_speech'
-require 'md2slides/audio'
-require 'md2slides/video'
+
+module Md2slides
+	class Error < StandardError; end
+
+	# XXX: platform independent path configuration...
+	ENV['GOOGLE_APPLICATION_CREDENTIALS'] ||= File.join(Dir.home, ".config/gcloud/credentials.json")
+
+	require 'md2slides/md'
+	require 'md2slides/presentation'
+	require 'md2slides/text_to_speech'
+	require 'md2slides/audio'
+	require 'md2slides/video'
+	require "md2slides/version"
+end

data/md2slides.gemspec

@@ -0,0 +1,47 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "md2slides/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "md2slides"
+  spec.version       = Md2slides::VERSION
+  spec.authors       = ["Motoyuki OHMORI"]
+  spec.email         = ["ohmori@tottori-u.ac.jp"]
+
+  spec.summary       = %q{Markdown to presentation slides in ruby.}
+  spec.description   = %q{Generate Google slides and its video file from a markdown file.}
+  spec.homepage      = "https://github.com/ohmori7/md2slides"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+#   spec.metadata["allowed_push_host"] = spec.homepage
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "googleauth"
+# spec.add_dependency "google-apis-people_v1"
+  spec.add_dependency "google-apis-slides_v1"
+  spec.add_dependency "google-apis-drive_v3"
+  spec.add_dependency "google-cloud-text_to_speech", "~>0.7.0"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.license	= "MIT"
+end

data/vendor/bundle/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

metadata

@@ -1,33 +1,149 @@
 --- !ruby/object:Gem::Specification
 name: md2slides
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Motoyuki OHMORI
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2025-04-29 00:00:00.000000000 Z
-dependencies: []
-description: Generate Google slides and its video file from a markdown file
-email: ohmori@tottori-u.ac.jp
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-apis-slides_v1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-apis-drive_v3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-text_to_speech
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Generate Google slides and its video file from a markdown file.
+email:
+- ohmori@tottori-u.ac.jp
 executables:
 - md2slides
+- text2mp3
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/md2slides
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- bin/console
+- bin/setup
+- exe/md2slides
+- exe/text2mp3
 - lib/md2slides.rb
 - lib/md2slides/audio.rb
 - lib/md2slides/md.rb
 - lib/md2slides/presentation.rb
 - lib/md2slides/text_to_speech.rb
+- lib/md2slides/version.rb
 - lib/md2slides/video.rb
+- md2slides.gemspec
+- vendor/bundle/.gitignore
 homepage: https://github.com/ohmori7/md2slides
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/ohmori7/md2slides
+  source_code_uri: https://github.com/ohmori7/md2slides
+  changelog_uri: https://github.com/ohmori7/md2slides
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -46,5 +162,5 @@ requirements: []
 rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
-summary: Markdown to presentation slides in ruby
+summary: Markdown to presentation slides in ruby.
 test_files: []