# ydpic

**Repository Path**: prehisle_admin/ydpic

## Basic Information

- **Project Name**: ydpic
- **Description**: 将`有道云笔记`免费版作为图床使用的小工具，可与`Typora`完美结合
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 29
- **Forks**: 5
- **Created**: 2020-03-29
- **Last Updated**: 2024-05-23

## Categories & Tags

**Categories**: text-editor

**Tags**: None

## README

<!-- toc -->
- [项目介绍](#项目介绍)
- [效果演示](#效果演示)
- [快速上手(WINDOWS10)](#快速上手windows10)
  - [下载软件](#下载软件)
  - [配置](#配置)
    - [准备`有道云笔记`账号密码](#准备有道云笔记账号密码)
    - [准备`有道云笔记`分享笔记的链接](#准备有道云笔记分享笔记的链接)
    - [配置`ydpic`](#配置ydpic)
  - [集成到Typora](#集成到typora)
- [快速开始(pip方式)](#快速开始pip方式)
  - [安装](#安装)
  - [配置](#配置-1)
  - [使用](#使用)
  - [帮助](#帮助)
- [支持系统](#支持系统)
- [项目起源](#项目起源)
- [常风问题](#常风问题)
<!-- toc -->

## 项目介绍

将`有道云笔记`免费版作为图床使用的小工具，可与`Typora`完美结合

## 效果演示

![ydpic效果演示](imgs/demo.gif)

## 快速上手(WINDOWS10)

### 下载软件

| 下载链接                                                     | 说明         |
| ------------------------------------------------------------ | ------------ |
| [码云](https://gitee.com/prehisle/ydpic/attach_files/386017/download) | 有限速50KB/S |
| [蓝奏云](https://prehisle.lanzous.com/icaqutc)               | 推荐         |

### 配置

#### 准备`有道云笔记`账号密码

略

#### 准备`有道云笔记`分享笔记的链接

1. 登录网页版有道云笔记

   [有道云笔记官网](https://note.youdao.com/)

2. 随便分享一个文档,复制分享链接,后面会用到,如下图

   ![获取分享文档链接](imgs/share_note.png)

#### 配置`ydpic`

1. 解压下载的软件
略

3. 修改配置

打开`config.ini`配置你的有道云笔记账号密码及分享文档链接，内容如下
```
[basic]
# 账号
username = xxx@126.com

# 密码
password = xxx

# 笔记分享链接
share_url = http://note.youdao.com/noteshare?id=41112cc5871c7abf8ae2c90c3f174804
```

### 集成到Typora

* 在`Typora`菜单`文件`->`偏好设置..`->`图像`->`自定义命令`中填入，

  ```
  "{ydpic解压路径}\ydpic.exe" upload -c "{ydpic解压路径}\config.ini"
  ```
将`{ydpic解压路径}`替换成
* 点击`验证图片上传选项`进行上传测试，测试成功大功告成如下图

  ![typora_test](imgs/typora_test.gif)

## 快速开始(pip方式)

### 安装

```
pip3 install ydpic
```

### 配置

* 在当前目录生成`config.ini`配置文件

```
ydpic init
```

* 在`config.ini`配置相关参数

```
[basic]
# 账号
username = xxx@126.com

# 密码
password = xxx

# 笔记分享链接
share_url = http://note.youdao.com/noteshare?id=41112cc5871c7abf8ae2c90c3f174804
```

### 使用

```
ydpic upload 1.png 
```

### 帮助

```
usage: ydpic upload [-h] [-c --config CONFIG_FILE_PATH]
                    [-f --format {raw,typora,markdown}] [-t --tmp_dir TMP_DIR]
                    files [files ...]

positional arguments:
  files                 image files

optional arguments:
  -h, --help            show this help message and exit
  -c --config CONFIG_FILE_PATH
                        config file path.
  -f --format {raw,typora,markdown}
                        img output format.
  -t --tmp_dir TMP_DIR  tmp_dir.

```



## 支持系统

| 系统         | 测试结果 |
| ------------ | -------- |
| win7         | √        |
| win10        | √        |
| ubuntu 18.04 | √        |
| xp           | x        |
| 其他系统           | 未测试        |

## 项目起源

* 免费版的有道云笔记在编写markdown格式的笔记时不支持直接粘贴图片，必须把图片上传到图床后再把url粘贴回来，多有不便
* Typora写Markdown体验实在是爽,但把带有图片的文档发到Blog时需要手动将图片传到图床，麻烦
* 有道云笔记的html格式的笔记可以直接粘贴图片
* Typora支持调用命令行程序上传图片获取url
* 遂写程序模拟上传图片的过程并获取图片url

## 常风问题

* 开启`link_resourceId = True`且上传路径中包含中文的图片时，由于有道云笔记对中文url的支持有问题，故在返回的url中将中文替换成了`_`，这将导致本地图片与图片无法对应上

* 为支持python3.6，直接运行ydpic会报错
  `AttributeError: 'Namespace' object has no attribute 'func'`，请忽略这个错误，不影响实际使用，要看帮助请执行·ydpic -h
  ·。[问题参考](https://github.com/python/typeshed/issues/2415) 

* 有道云笔记做了防盗链，在img标签中加入`referrerPolicy="no-referrer"`可正常显示图片

* linux下提示

  ```
  No matching distribution found for tkinter
  ```

  则需要安装tk,ubuntu18.04下的安装命令如下

  ```
  sudo apt-get install python3-tk
  
  ```