TwitterのBOTくらいなら簡単に作成できる…と思っていたのですが、先日のBASIC認証廃止で、OAuthによる認証が必須となり、簡単なBOTでも結構ややこしい手順をふむ必要が出てきました。
そこで、少しでも楽をするために、今回はPythonを使って構築しています。
適当なライブラリを活用することで、認証の処理がかなり容易になります。

以下、一連の作業と作成したソースコードの記録です。

BOTアカウントの登録

なにはともあれ、BOT用のアカウントを登録します。
こちらのページから、通常通りアカウントを作成します。

後々、このアカウントに紐づいたアクセストークンが必要となります。

登録を終えたら通常通りログオンし、Bio等をセッティングします。

アプリケーションの登録

次に、BOT用アカウントでログインした状態で http://dev.twitter.com/ へアクセスします。

この画面から、新しく作成するBOTをアプリケーションとして登録します。
右上の “Your apps”  をクリックします。

既に登録しているアプリケーションの一覧が表示されます。
何も登録していない場合は、登録画面へのリンクだけが表示されるはずです。

新しく登録する場合は、右の “Register a new app” をクリックします。

基本的に、入力項目はすべて入力する必要があります。

BOT用アプリケーション登録の際のポイントは、 “Application Type” を “Client” に変更することと、 “Default Access type” を “Read & Write” に変更すること。
ちなみに、 “Callback URL” の入力欄は、 “Application Type” を “Client” に変更すると消えます。

登録が完了すると、このような画面に移ります。

この画面で必要な情報は、 “OAuth 1.0a Settings” の “Consumer key” と “Consumer secret” の2つ。
これらの情報が、このBOTを更新するためのアプリケーションである、ということを証明するのに使われるものです。
これらの情報を記録します。

次に、画面の上に戻って “My Access Token” をクリックします。

すると、このように “Access Token (oauth_token)” と “Access Token Secret (oauth_token_secret)” の情報が表示されます。
これは、このアプリケーションの作成者(=BOTアカウント)の認証に使われる情報です。

先の “Consumer key” 、 “Consumer secret” とあわせて、初めてBOTを更新するためのアプリケーションで、BOTアカウントのツイートを更新できるようになります。
“Access Token (oauth_token)” と “Access Token Secret (oauth_token_secret)” の情報も記録しておきます。

これで、BOTに必要な “Consumer key”、 “Consumer secret”、”Access Token (oauth_token)”、 ”Access Token Secret (oauth_token_secret)” という4つの鍵が手に入りました。

スクリプトの作成

上述のように、今回BOTを更新するアプリケーションは、Pythonによるスクリプトを作成しました。

PythonでのTwitterの操作は tweepy というライブラリを利用しています。
また、Flickrからの写真の取得は、Flickrのタグをキーに写真を検索してRSSを作成してくれる Flickr RSS Feed Generator というサービスを利用し、この結果取得したRSSを feedparser というライブラリを使ってパースしています。
更に、 今回はFlickrの写真をツイートするということで、 flickrapi.shorturl というライブラリでURLを短縮しています。

各ライブラリのインストールは環境により異なるので、他を参照いただきたいのですが、このBlogを置いているCoreserverやXREAの場合は基本的に次のような手順でインストールできると思います。

1. 管理画面からホスト情報を登録する。
2. SSHでサーバへアクセスする。
3. 次の環境変数を設定しておく。

$ export PYTHONPATH=$HOME/lib/python2.4:$HOME/lib/python2.4/site-packages

4. 各ソースコードをダウンロードし、以下のコマンドでインストール先を指定してインストールする。

$ python setup.py install --prefix=~/

次に、実際にBOTを更新するスクリプトのソースコードです。ここで、”Consumer key”, “Consumer secret”, “Access Token (oauth_token)”, ”Access Token Secret (oauth_token_secret)”にはそれぞれ植えで入手した情報を入れて下さい。

#!/usr/local/bin/python
# -*- coding: utf-8 -*-

import string
import random

import feedparser
import tweepy
import flickrapi.shorturl

CONSUMER_KEY        = 'Consumer key'
CONSUMER_SECRET     = 'Consumer secret'
ACCESS_TOKEN        = 'Access Token (oauth_token)'
ACCESS_TOKEN_SECRET = 'Access Token Secret (oauth_token_secret)'

num = 100    # 100枚の写真から1枚選ぶ
tag = 'cat+kitty+kitten'    # 検索するタグを + で繋げる
id = random.randint(0, num)
if random.randrange(0, 10, 1) > 5:
  sort = 'interestingness-desc'
else:
  sort = 'date-posted-desc'

url  = 'http://www.degraeve.com/flickr-rss/rss.php?tags=' + tag + '&tagmode=any&sort=' + sort + '&num=' + str(num)
data = feedparser.parse(url)

prefix = u'ミ^・.・^彡'
title  = data['entries'][id]['title']
link = data['entries'][id]['link']
link = flickrapi.shorturl.url(link[link.rfind(u'/')+1:])

if len(title) + len(link) + len(prefix) > 110:
  title = title[0:110 - len(link) - len(prefix)] + '...'

tweet = prefix + ' ' + title + '  ' + link

# ここからTwitter
auth = tweepy.OAuthHandler(CONSUMER_KEY, CONSUMER_SECRET)
auth.set_access_token(ACCESS_TOKEN, ACCESS_TOKEN_SECRET)
api = tweepy.API(auth)
api.update_status(tweet)

最後に、このスクリプトをcronで動かすためのshスクリプトを作成します。ここで、上のPythonスクリプトは /virtual/user/bin/nyancopot.py に保存されているものとします。

#!/bin/sh

export PYTHONPATH=$HOME/lib/python2.4:$HOME/lib/python2.4/site-packages
export LD_LIBRALY=$HOME/lib

/usr/local/bin/python /virtual/user/bin/nyancopot.py

あとは、このshスクリプトをcronに登録すれば完了です。
指定された時間にBOTがつぶやきます。

先日の記事ではePubを作成するシェルスクリプトを公開しましたが、いちいちターミナルからスクリプトを実行するのも面倒なので、AppleScriptを使ってFinderからスクリプトを呼出し、Finderで開いているフォルダ内の連番画像をePubに変換するアプリケーションを用意しました。AppleScriptですので、Mac専用です。

連番画像ファイル->ePub作成アプリケーション

簡単な使い方は以下の通り。なお、未検証ですが連番画像のファイル名に日本語が含まれていると上手くいかないかも知れませんので、ファイル名は英数字のみにしておいた方が無難だと思います。

1. 自分のホームディレクトリに “bin” フォルダを作成します。
2. dmgに入っている “epubsh.sh” を1.で作成した “bin” フォルダにコピーします。
3. dmgに入っている “epubsh.app” を任意の場所 (“bin” や “アプリケーション” をおすすめします) にコピーし、DockもしくはFinderのツールバーに登録します。
4. ePubに変換したい一連の画像のあるディレクトリを最前面のFinderで開いた状態にし、3.で登録した “epubsh.sh” を実行します。
5. タイトル、著者を入力するダイアログが表示されるので、それらを入力します。
6. 暫く待つと、画像と同じディレクトリに “タイトル.epub” という名前でePubファイルが作成されます。

以上です。いつも通り検証不十分ですので、At Your Own Riskでお願いします。コメント等々ございましたら@naokisatoname宛に頂けると幸いです。

以下、スクリーンショット付きの詳細説明とスクリプトのソース。

詳細設定手順

ここでは、以前ScanSnapからPDF形式で電子化し、今回検証のためにjpgで画像を抽出した新海誠さんの小説・秒速5センチメートルを使用しています(連番画像ファイル名は “5cm_xxx.jpg”)。

1. 上のリンクからdmgファイルをダウンロードします。
2. Finder上でダブルクリックし、マウントします。
3. 中に “epubsh.app” と “epubsh.sh” の2ファイルが入っていることを確認します。
4. 自分のホームディレクトリに “bin” フォルダを作成します。
5. dmgに入っている “epubsh.app” と “epubsh.sh” を “bin” フォルダにコピーします。
   
6. “epubsh.app” をDockもしくはFinderのツールバーに登録します。個人的にはFinderのツールバーの方が使い易い気がします。
   
7. 連番画像ファイルをおいたディレクトリをFinderで表示します。
   
8. 先ほど登録した “epubsh.app” をクリックして実行します。
9. Book Title: というダイアログが表示されるので、本のタイトルを入力します。
   
10. Book Author: というダイアログが表示されるので、本の著者を入力します。
    
11. OKをクリックして暫く待つと、Finderで開いていた、画像と同じディレクトリに “タイトル.epub” というePub形式のファイルが作成されます。
    
12. 後はePubを表示して読書を楽しみましょう。
    

ソースファイル

AppleScriptおよびsh Scriptのソースです。基本的にdmgファイルの内容と同様です。ダウンロードが上手くいかない際は、右クリックでファイル名を指定して保存して下さい。

• AppleScript (2.6KB)
• sh Script (3.3KB)

知識のある方、改変・修正はご自由に。その際は後学のため@naokisatonameまでご連絡いただければ幸いです。

※2010/04/08追記

公開したスクリプトにバクがあったので、dmg、ソースとも置き換えました。

タイトルやパスにスペースが含まれていた際に正常に動作しない現象を修正しました。

※ 2010/04/26追記

dmg、ソースを再度置き換えました。

前回と同じく、タイトルやパスにスペースが含まれていた際に正常に動作しない不具合の修正です。

スクリプト内でディレクトリ名をクォートするのを忘れておりました。スミマセン…

※ 2010/05/09追記

dmg、ソースを置き換えました。

作成されたePubがAppleのiBooksで開けないバグを修正しました。

ただし、iBooksでは画像のサイズを変更する指定が無効になるらしく、表示が崩れる可能性があります。

ただ、惜しむらくは書籍として認識されるのがePub形式のみという点。以前からPDFはiTunesで管理できましたが、書籍形式としては認識されず、このことからiPad上のiBooksではePub形式の電子書籍のみがサポートされることが予想されます。

海外の古い書籍であればGoogle BooksやProject Gutenbergで入手できますし、日本の古典は拙作のBookmarkletを使えば青空文庫からePubを作成できることができます。しかし、現在紙の本から電子データを作成する上で最も一般的と思われるScanSnap (+裁断機)では、PDFを作ることはできてもePubは作成できず、このままではiPad (というかiBooks)で市販の書籍を読む事が難しそうです。

他方、ScanSnapでは連番画像ファイルとして電子データを保存できます。そこで、連番の画像ファイルからePubを作成するシェルスクリプトを書いてみました。

連番画像ファイル->ePub作成スクリプト

べた書きの上にきちんとテストも行っていない状態なので、いつも通りAt Your Own Riskでお願いします。変更はご自由に。

以下、スクリプトの使用方法と説明です。

前提

• bashスクリプトなので、MacもしくはLinux等Unix系OSが必須です。
• 元画像ファイルは .jpg もしくは .png いずれかの形式・拡張子で、ファイル名は連番になっている必要があります。
• スクリプトはターミナル・コンソールから実行する必要があります。

実行方法

1. 任意のディレクトリにePubに変換する一連の連番画像ファイルとスクリプトファイル(epubsh.sh)を置きます。

   $ ls .

     001.jpg

     002.jpg

     003.jpg

     epubsh.sh

2. ターミナルで1.で画像、スクリプトを置いたディレクトリに移動します。

   $ cd /home/user/hoge

3. 引数に書籍のタイトル、著者名を入力してスクリプトを実行します。

   $ sh epubsh.sh タイトル 著者

4. 実行したディレクトリに”(書籍のタイトル).epub”というファイル名が作成されます。

動作確認

Mac上のSony Reader Library、Stanza、iPhone上のStanza、Sony Readerで表示確認済み。

予想以上にiPhone上のStanzaで読めました。

やっていること

基本的に以前ポストしたePub形式のファイル構成に従って必要なファイルを作成し、パッケージ化しているだけです。

• 画像ファイルを/tmp以下の作業フォルダにコピー
• 各画像ファイルを表示するためのhtmlファイルを作成
• CSSで画像ファイルをheight=100%、text-align=centerに
• ePub用のファイルを作成
• ePub用のフォルダ構成に設定
• zipでePub形式を作成
• ePubを作業フォルダからカレントフォルダに移動
• 作業フォルダを削除

今後は…

正直な所、今後書籍の電子化をPDF形式にするべきかePub形式にするべきかは分かりかねるところです。

PDFは既に広く一般化していて、電子書籍としてだけではなくMac等ではOSレベルでサポートされているものの、iPadやE-Bookリーダでのサポートが弱い。

ePubはiPadのiBooksでも標準サポートされ、主要なE-Bookリーダでサポートされるものの、Mac等で扱いにくい。

実は画像ファイルで電子化しておくのが一番汎用的なのかも知れません。