Python-SmartisanNotes

Python API Wrapper for http://note.t.tt Service.

利用 Requests、requests_toolbelt 等库模拟浏览器操作，实现锤子便签网页版的基本功能。

功能介绍

基本功能

• 获取便签列表
• 新建便签
• 修改便签
• 删除便签
• 生成锤子便签分享图片

实验性功能

• 便签备份（导出至 JSON 文件）
• 便签恢复（从 JSON 文件导入）

代码说明

Python 版本

支持 Python 2.6 以上版本。

第三方库支持

• requests
• requests_toolbelt
• simplejson

演示环境

CrunchBang Linux waldorf (Debian GNU/Linux 7.9)

应用示例

1. 初始化及登录

from SmartisanNotes import *
username = 'Your Username'
password = 'Your Password'
# 创建新实例，同时完成登录
s = SmartisanNotes(username, password)
print s.uid

2. 获取便签列表

noteList = s.noteGetList()
print noteList

3. 新建便签

1) 新建文本便签（支持部分 Markdown 语法）

# noteCreate(detail, [mode='2', fav='0', note2Img='0'])
# formatting mode: 0 (Text) / 1 (Rich Text Format) / 2 (Markdown)
# fav='1' 添加为收藏；
text = 'Hello, World!\nHello Kitty'
note = s.noteCreate(detail=text, fav='1')
print note

返回值：

{
   'note':{
      'markdown':0,
      'uid':2387566,
      'title':'Hello, World!',
      'sync_id':'007wa313j',
      'detail':'Hello, World!\nHello Kitty',
      'favorite':1,
      'pos':15,
      'eseqid':826802164717322241,
      'seqid':826802164650213377,
      'modify_time':1485960035468,
      'call_timestamp':0,
      'tab_id':'NmIzN2Jl',
      'formatting_mode':2,
      'folderId':0
   }
}

# note2Img='1' 生成分享图片（返回图片信息），同时保存至本地
text = '>Hello, World!\nHello Kitty'
note, image = s.noteCreate(detail=text, mkd='1', note2Img='1')
print image

返回值：

{
   'width':660,
   'image':'https://cloud.smartisan.com/apps/1485961181/weiboimage/pN55RRxdZdphJJdRNllhtNF9Fx5B5FZVZVRJV9pN95xtxddF.jpg',
   'height':359
}

2）新建图文便签

# imageUpload(imageFile, [describe='', text='', reverse='0', mode='2', fav='0', note2Img='0'])
# 支持上传本地图片及在线图片，支持 jpeg、png 格式，文件大小不超过 5 MB
# describe 为图片描述，纯 ASCII 字符限 30 字，纯 UTF-8 字符限 15 字，超出将被忽略
note = s.imageUpload('Octocat.jpg')

imageFile = 'http://image.wufazhuce.com/Fh7OzcpPtSnfC4s60p07sEdvjIzg'
describe = '基因乐趣&人畺 作品'
text = '没人可以永远的活在青春里，但还好，如若有心，我们能见证一代又一代的年轻。\
这种见证，也便成了一种参与。 by 自由极光\n\n[「ONE · 一个」 VOL.1161]'
s.imageUpload(imageFile, describe=describe, text=text, note2Img='1')

# reverse='1'，互换图文顺序
imageFile = 'Tie_My_Boat.jpg'
describe = 'Tie My Boat by Ray García'
text = 'Ubuntu Wallpapers\n'
s.imageUpload(imageFile, describe=describe, text=text, reverse='1', note2Img='1')

3）新建长图文便签

# noteArticle(detail, [mode='2', fav='0', note2Img='0'])
# 支持 Markdown 语法式的图片插入：![describe](imageFile)
# 支持上传本地图片及在线图片，支持 jpeg、png 格式，文件大小不超过 5 MB
article = '''
#生物股长（いきものがかり）
![生物股长（いきものがかり）](http://t.cn/Rqxv82C)
生物股长，日本当红流行乐团，由吉冈圣恵、水野良树、山下穗尊三人组成于2002年2月1日。\
所属事务所为 CUBE Group，所属唱片公司为EPIC Records（日本 SONY 唱片旗下厂牌）。
![](album.jpg)
'''
s.noteArticle(detail=article, note2Img='1')

4. 修改便签

# noteUpdate(syncId, detail, [mode='2', fav='0', note2Img='0'])
# syncId 为同步 ID，也是便签唯一的标识
text = 'Hello Kitty\nHello Hello Hello Kitty'
s.noteUpdate('007w69yzo', detail=text)
# noteUpdateFormattingMode(syncId, mode)
# 仅修改 formatting mode: 0 (Text) / 1 (Rich Text Format) / 2 (Markdown)
s.noteUpdateMarkdown('007w69yzo', mode='2')
# noteUpdateFav(syncId, [fav='1'])
# 仅修改 favorite 属性
s.noteUpdateFav('007w69yzo', fav='0')

5. 删除便签

# noteDelete(*syncIds)
# 永久性删除，请谨慎操作
s.noteDelete('007w69yzo', '007w68yv7', '007w69p7m')

# 删除所有便签！！！
#syncIds = [note['sync_id'] for note in s.noteGetList()['list']]
#s.noteDelete(*syncIds)

6. 便签备份（导出至 JSON 文件）

# noteBackup(fileName='')
# 导出所有便签数据，生成 JSON 文件。注：并未下载图片、音频等资源
s.noteBackup(fileName='Notes.json')

7. 便签恢复（从 JSON 文件导入）

# noteRestore(fileName)
# 从本地 JSON 文件导入便签数据，便签同步 ID 如果已存在，则更新便签信息；如果不存在，则新建便签。
# 注：尚未知晓已删除便签包含的图片、音频资源在服务器的留存时间，故部分恢复的便签信息可能不完整。
s.noteRestore('Notes.json)

更新日志

v0.3.0 (2017-02-01)

• 官方版本升级，部分接口调整

v0.2.0 (2016-04-12)

• 优化 imageUpload() 方法，并新增 reverse 参数，用以交换文字和图片顺序；
• 新增 article() 方法，支持 Markdown 语法式的图片插入，长图文排版更加灵活。

v0.1.0 (2016-04-04)

• 项目初始化

Todo

• 增加文件夹功能支持
• 增加回收站操作支持
• 增加富文本格式支持
• 优化便签备份恢复
• 优化图片裁剪操作

License

MIT License.