A simple & beautiful tool for pictures uploading built by python
Project description
PyPicGo 是参考PicGo开发的一款图床上传的图传工具,并支持各种插件自定义插件,目前PyPicGo自带了gitee、github和七牛云图传,和rename、notify和typora等插件,并支持从pypi中下载其他插件和Uploader。
安装
pip install pypicgo
配置
配置文件位于/$HOME/.PyPicGO/config.yml目录下,采用YAML的方式进行配置。必须配置上传器uploader,插件plugins的数量可选
uploader:
name: gitee # 图传名称
module: pypicgo.uploaders.gitee.uploader.GiteeUploader # 上传插件模块
config: # 上传插件初始化配置
owner: PyPicGo
repo: PyPicGo
img_path: PyPicGo
access_token: xxxxxxxxxxxx
plugins: # 插件列表
- module: pypicgo.plugins.rename.ReNamePlugin # 插件模块
config: # 插件配置
- module: pypicgo.plugins.notify.NotifyPlugin
- module: pypicgo.plugins.clipboard.ClipBoardPlugin
- module: pypicgo.plugins.typora.TyporaPlugin
更多的配置说明参考文档
使用
pypicgo xxx.jpg
支持的图床
图床名 |
模块地址 |
---|---|
gitee |
pypicgo.uploaders.gitee.uploader.GiteeUploader |
七牛云 |
pypicgo.uploaders.github.uploader.QiNiuUploader |
github |
pypicgo.uploaders.qiniu.uploader.GithubUploader |
SM.MS |
pypicgo.uploaders.smms.uploader.SmmsUploader |
支持的插件
插件名称 |
用途 |
windows |
linux |
mac |
---|---|---|---|---|
rename |
上传前重命名图片 |
支持 |
支持 |
支持 |
notify |
上传成功失败的系统通知 |
支持 |
支持 |
支持 |
typora |
typora编辑器支持 |
支持 |
支持 |
支持 |
compress |
图片上传前压缩 |
支持 |
支持 |
支持 |
Uploader上传器
uploader是具体的上传插件,用户需要继承pypicgo.core.base.uploader.CommonUploader并实现upload方法,然后在配置文件中引用即可.
插件系统
PyPicgo支持的插件分为三种before、after和final
插件类型 |
运行时间 |
基类类 |
示例插件 |
运行时入参 |
---|---|---|---|---|
before |
在图片上传前运行 |
pypicgo.core.base.plugin.BeforePlugin |
rename |
File |
after |
在图片上传后运行 |
pypicgo.core.base.plugin.AfterPlugin |
notify |
Result |
final |
在所有图片上传后运行 |
pypicgo.core.base.plugin.FinallyPlugin |
typora |
List[Result] |
如果想自定义插件只要根据要求继承任意一个基类插件,并实现execute方法,并在config.yml中配置即可使用.
开发
git clone git@github.com:AnsGoo/PyPicGo.git
cd pypicgo
pipenv shell
pipenv install
python run.py xxx.jpg
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.