Skip to content

Latest commit

 

History

History
299 lines (199 loc) · 14.4 KB

README.ja.rst

File metadata and controls

299 lines (199 loc) · 14.4 KB
Raw

dontwi

概要

dontwi はMastodonのハッシュタグ付きのstatus [1] をTwitterに転送するスクリプトです．

転送トリガーには固定ハッシュタグ #don_tw と，他にお好みのハッシュタグを設定することができます． dontwiは，これらのハッシュタグが付いたstatusを公開ローカルタイムラインから見つけて転送を行います．

Twitterに投稿する際にはMastodonにおけるユーザー名と #don_tw が付記されます． このハッシュタグを付ける目的は，Twitter上でこのハッシュタグによる擬似的な連合を形成するすることです． この狙いについては TOMOKI++(@tomoki@vocalodon.net) が Mastodon 2 Advent Calendar 2017 でが説明しています．

Read this in English

[1]Twitterにおけるツイート，Mastodonにおけるトゥートは，APIドキュメント内でstatusと表現されています．

特徴

  • dontwi は Python 3.4 以上， CentOS 7.4および Ubuntu 16.04，Windows 10をサポートします．
  • cron と共に使うと便利です．起動毎に1つのstatusを転送します.
  • 指定されたハッシュタグを持つstatusを公開ローカルタイムラインから見つけて転送を行います．
  • Mastodonに投稿された長いテキストはTwitterの制限に合わせて切り詰めまれます．
  • Twitterに投稿されるstatusにはMastodonにおけるユーザー名が付記されます．
  • 添付された画像ファイルも一緒に転送されます.
  • 転送したstatusを記録しているので，一度転送されたstatusが再び転送されることはありません．

どのように動くのか

dontwiはMastodonのローカルタイムラインにある指定されたハッシュタグをもつstatusを転送します．例えばMastodonに投稿されたFig.1 のstatusはTwitterにFig.2のように投稿されます．

images/sample_toot.png

Fig.1 Sample status on Mastodon

images/result_tweet.png

Fig.2 Transported status on Twitter

dontwiは実行毎にMastodon APIを用いてはハッシュタグタイムラインを取得します．指定のハッシュタグもしくは #don_tw がついたstatusを見つけると，まずこれらをログDBに保存します．

次にログDBにある最も古いstatusを取り出し，TwitterにAPIを用いて投稿します．このstatusには投稿者のMastodonにおけるアドレスとハッシュタグ #don_tw が付記されます． statusに添付されたメディアファイル [2] もTwitterの制約に合わせてリサイズしてから一緒に投稿されます．

ツイッターの文字数上限280文字 [3] 以内ならば，status中のテキスト，リンク，ハッシュタグはそのまま維持されます．この文字数上限を越えている場合は，可能な限りリンクとハッシュタグを維持したままテキストだけが切り詰められます．また，複数のツイートに分けてスレッドとして投稿することもで行えます(v1.1.0以降)．

Twitterに投稿される際に付記されるハッシュタク #don_tw は，設定により変更することはできません．これは，このハッシュタグによりTwitter上で連合タイムラインを形成される事を意図している空です．もし他のハッシュタグに変更したい場合はソースコードを直接修正してください．ですが，できましたらTwitter上の連合タイムライン形成にご協力いただけないでしょうか.

[2]This is currently only available for image files.
[3]全角文字は半角文字2文字として計上

インストール

pip3を用いてこのレポジトリにあるパッケージを簡単にインストールすることができます:

pip3 install https://github.com/vocalodon/dontwi/releases/download/v1.1.1/dontwi-1.1.1-py3-none-any.whl

setup.py を用いてローカルのレポジトリからインストールすることもできます:

python3 setup.py install

設定

1. 設定ファイルを用意する

設定ファイル dontwi.ini を /etc に置いてください. dontwi.ini の検索パスは /etc aとカレントディレクトリです．設定ファイルのテンプレート examples/dontwi.ini はこんな感じです:

[operation]
inbound = your_mastodon
trigger = hashtag:your_hashtag
outbound = dontwi

[endpoint your_mastodon]
type = mastodon
api_base_url = https://your_mastodon.domain
client_name = dontwi
since =

[endpoint dontwi]
type = twitter
app_key =
app_secret =
oauth_token =
oauth_token_secret =
message_length = 280
post_mode = single

[result log]
db_file = /var/db/dontwi_log.db

2. インスタンスに合わせて設定を変更する

dontwi.ini をあなたのMastodonインスタンスとTwitterアカウントに合わせて変更してください． 設定が必用な最小限のパラメータは以下の通りです． なお，設定ファイル中にはコメントを書かない方が良いです．これは，Mastodonのクラインアントキーを保存する際にコメントが削除されてしまうからです．

operation セクション

inbound

発信元の定義が書かれているのセクション名

このセクション名は変更することができますが，ここの記述と発信元の定義を定めているセクション名の対応関係は維持してください．

trigger

検出トリガーとするハッシュタグ

ハッシュタグの前にはプレフィックス hashtag: を付けてください．またハッシュタグの # は抜いて記述してください．

outbound

着信先の定義が書かれているセクション名

着信先の定義について inbound の場合と同様に記述してください．

endpoint your_mastodon セクション

type

発信元のタイプ

mastodon と書いてください．なお，将来のバージョンでは他のタイプもサポートれるかもしれません．

api_base_url
MastodonインスタンスのベースURLを書いてください．
client_name
APIアクセスの際のクライアント名を書いてください．

endpoint dontwi セクション

type

着信先のタイプ

twitter と書いてださい．なお，将来のバージョンでは他のタイプもサポートれるかもしれません．

app_key, app_secret, oauth_token, oauth_token_secret
TwitterのAPIキーと関連パラメーターを書いてください．dontwiはTwitterのAPIアクセスに Twython ライブラリを用いています．これらのパラメーターの取得方法については Twythonのドキュメントを参照してください．
message_length
トゥートを切り詰める際の文字数上限です．デフォルトは280です．
post_mode
``single``（デフォルト）または``thread``が選択できます．``single``の場合は，statusのテキストを``message_length``に収まるように切り詰めて投稿します．``thread``の場合は，statusのテキストを``message_length``ごとに分割してスレッドとして投稿します．

result log セクション

db_file

ログDBファイルへのパス

ログDBファイルへのパスを書いてください．デフォルトはカレントディレクトリの dontwi_log.db です．FHS に準拠した /var/db/dontwi_log.db とすることをお勧めします．

3. 設定の確認

インストールが成功したかどうか，--help オプションをつけて dontwi を起動することで確認できます．:

[root@centos7 opt]# dontwi --help
usage: dontwi [-h] [--config-file CONFIG_FILE] [--summary] [--trigger TRIGGER]
          [--since SINCE] [--until UNTIL] [--limit LIMIT] [--dry-run]
          [--get-secret] [--dump-status-strings] [--dump-log]
          [--dump-log-readable] [--remove-waiting] [--remove-wrong]
          [--db-file DB_FILE]

A status transporter from Mastodon to Twitter

optional arguments:
  -h, --help            show this help message and exit
  --config-file CONFIG_FILE
                    Using CONFIG_FILE instead of the default.
  --summary             Showing summary of log DB
  --trigger TRIGGER     Using TRIGGER instead of trigger in the config file
  --since SINCE         Using SINCE instead of since in the config file
  --until UNTIL         Using UNTIL instead of until in the config file
  --limit LIMIT         Using LIMIT instead of limit in the config file
  --dry-run             Getting the last status with the hashtag, but don't
                    send status to outbound service.
  --get-secret          Getting the access keys and others from Mastodon
                    instance and saving these in the config file.
  --dump-status-strings
                    Dumping status strings to be marked as 'Waiting'
                    status
  --dump-log            Dumping all records in the log database.
  --dump-log-readable   Dumping all records in the log database in a human-
                    readable format.
  --remove-waiting      Removing records in 'Waiting' from the database
  --remove-wrong        Removing records in 'Waiting' from the database
  --db-file DB_FILE     Using log DB_FILE instead of db_file of [result log]
                    section in the config file.

もし何らかの問題が残されているならこの段階でエラーメッセージが表示されるでしょう．

dontwi.ini を確認するには dontwi を --dry-run オプションを付けて起動することで行えます:

[root@centos7 ~]# dontwi --dry-run
Test at 2018-02-17T14:04:05.826111+00:00 in:your_mastodon,4705377 out:, tag:どんつい

最初にMastodonインスタンスにアクセスする際にdontwiはアクセスキーを config.ini に保存します．

dontwiを --dry-run オプションで起動すると，dontwiはMastodonの Timelines API を用いてタグタイムラインを取得し，Twitterに送るstatusの下準備を行います．

dontwiはAPIから取得したstatusの最も古い物をTwitterに投稿する準備まで行いますが，それ以降の処理を行いません． この処理は'Test'というラベルと付けてログDBに記録されます． その他のstatusは'Waiting'というラベルを付けて保存されます． これらのstatusは次回実行時に一つずつ投稿処理が行われます．

これらのラベルが付いた記録がログDBに何件あるかは --summary オプションをつけて実行することで確認できます．:

[root@centos7 opt]# dontwi --summary
dontwi version  1.0
log db  {'application': 'dontwi', 'version': '1.0'}
record number   25
Start   0
Waiting 23
Succeed 0
Failed  0
Test    2

Waiting ラベルが付けられたエントリー以外の投稿は行われないので Test エントリーは削除する必用があるでしょう．これは --remove-wrong オプションを付けて実行することで行えます:

[root@centos7 opt]# dontwi --remove-wrong

この実行により他のエラー関連のエントリーも削除されます．

以上の確認と準備ができたらオプションを付けずに dontwi を実行してください:

[root@centos7 ~]# dontwi
Succeed at 2018-02-17T14:04:05.826111+00:00 in:your_mastodon,4705377 out:, tag:どんつい

4. dontwi のエントリーをcrontabに加える

dontwiを実行するエントリーをcrontabに加えましょう．例としてはこんな感じでしょう:

*/2  *  *  *  * root       /usr/bin/dontwi

上記のエントリーは2分毎に dontwi を起動しています． examples/crontab も参考にしてください．

もし systemd の方が好みなら examples/dontwi.service と examples/dontwi.timer も参考にしてください．

ライセンス

Copyright 2017 A.しおまねき(@a_shiomaneki@vocalodon.net)

Dontwi is licensed under the GNU General Public License v3.0. See LICENSE for the troposphere full license text.

謝辞