小技チョコレート

ちょっとした小技を紹介するだけのブログです。

PCのTerminal(端末)からScrapboxに新しいページを作るPythonスクリプト

PCのTerminal(端末)からScrapboxに新しいページを作るPythonスクリプトを作ったので、コードと使い方を書いておきます。


〈目次〉


機能

  • 新しく作るページのタイトルを入力できる。
    • タイトルを空白にすると、日付(YYYY/MM/DD)がタイトルになる。
    • タイトルを付けずにページを作ることもできる。
  • 本文を1行のみ入力できる。

必要なもの

  • Pythonスクリプトを実行できること。
  • ウェブブラウザが使えて、そのブラウザでScrapboxにログインしていること。

利用上の注意点

上掲のとおり、Scrapboxで作るページのタイトルと本文を入力できますが、パスワードや個人情報などの「他人に見られると困る情報」をそこに入力するのはおすすめしません。

設定の手順

下記のコードのYOUR_PROJECT_URLのところを、書き込みたいScrapboxのプロジェクトURL(https://scrapbox.io/○○○/の○○○の部分)に書き換え、ファイル名をscrapbox.pyなどのように拡張子を.pyとして保存。

import urllib.request
import webbrowser
import datetime

project_url='YOUR_PROJECT_URL'
today = datetime.datetime.today().strftime("%Y/%m/%d")  #年月日の区切り方を変えたり、月と日の「0埋め」が不要なときは、この行を書き換える。

title=input('title >>')
if title=='':
    title=today
else:
    title_encode=urllib.parse.quote(title)

content=input("content >>")
content_encode=urllib.parse.quote(content)

#本文の末尾に自動で付けたいハッシュタグなどがあればtag=''のクォーテーションの間に書く。
#改行が必要な箇所には\nと書く。
#パスワードや個人情報などの「他人に見られたくない情報」はここにも記入しないことを推奨します。
tag='\n'

tag_encode=urllib.parse.quote(tag)

url='https://scrapbox.io/' + project_url + '/' + title +'?body=' + content_encode + tag_encode
webbrowser.open(url)

使い方

Terminalにて、上掲のスクリプトを保存したフォルダに移動し、python scrapbox.pyと実行。
title >>と表示されるので、次のいずれかを入力します。

  • ページに任意のタイトルを付けたいときは、それを入力。
  • 日付をページのタイトルにしたいときは、ここには何も入力しない。
  • タイトルを付けずに(=タイトルを空白にして)ページを作りたいときは、newと入力。

そしてEnterキーを押すと、その下の行にcontent >>と表示されるので、ページの本文として書き込みたい内容を入力します。改行はできません。

f:id:ichbin:20190808134109p:plain
(タイトルに「hoge」、本文に「ほげほげ #test」と入力した例)

そしてEnterキーを押すと、ウェブブラウザが開かれ、ページが作成されます。

f:id:ichbin:20190808125213p:plain

f:id:ichbin:20190808125329p:plain
(日付をタイトルにした場合)

f:id:ichbin:20190820230425p:plain
(タイトルに「new」、本文に「ほげほげ」と入力した場合)

Tips

追記の機能について

このスクリプトhttps://scrapbox.io/プロジェクトURL/タイトル?body=本文という形式のURLをブラウザで開くことによってページの作成を行っているわけですが、このURLの「タイトル」の部分が既存のページタイトルと同一であれば、その既存のページの末尾に「本文」部分が追記されます。*1*2

例えば「hoge」というタイトルのページが既に存在しているときにhttps://scrapbox.io/プロジェクトURL/hoge?body=本文というURLを開く(すなわち、このスクリプトtitle >>のところにはhogeと書く)と、既存の「hoge」ページに追記されます。

f:id:ichbin:20190808130300p:plain
(「pukupuku」の部分が、追記されたもの)

日時のハッシュタグを自動で付ける

ページを作成したり追記した際に、それをした日/月/年のハッシュタグ(例:#2019/08/08, #2019/08, #2019 など)を自動で付けるようにしておくと、使いようによっては便利かもしれません。それができるようにしたコードもこちらに置いておきます。

import urllib.request
import webbrowser
import datetime

project_name='YOUR_PROJECT_URL'
today = datetime.datetime.today().strftime("%Y/%m/%d")  #当日の日付
month=datetime.datetime.today().strftime("%Y/%m")  #当月
year=datetime.datetime.today().strftime("%Y")  #当年

title=input('title >>')
if title=='':
    title=today
else:
    title_encode=urllib.parse.quote(title)

content=input("content >>")
content_encode=urllib.parse.quote(content)

#当日をハッシュタグとして末尾に書き込む(例:#2019/08/08)。
#当月または当年に変えたいときは、todayのところをmonthまたはyearに書き換える。
#当日・当月・当年を全て書きたければtag='\n#'+today+'\n#'+month+'\n#'+yearなどとする(\nで改行1回)。
tag='\n#'+today
tag_encode=urllib.parse.quote(tag)

url='https://scrapbox.io/' + project_url + '/' + title +'?body=' + content_encode + tag_encode
webbrowser.open(url)

f:id:ichbin:20190808134252p:plain
(当日のハッシュタグ付きの例)

*1:ただしページタイトルを「new」とした場合は例外で、追記はされず別々のページとなります。

*2:このあたりの仕様についてはScrapboxのヘルプに解説があります。