new python project

Author: hy6544

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,44 @@
+# Markdown-img使用指南
+
+## 用途
+
+本程序用于扫描工作目录下的markdown文件，查找其中的本地图片并自动上传到`sm.ms`图床，并生成一个使用网络图片替换本地图片的markdown副本，存放于`当前工作目录/markdown_image`目录下。
+
+通过以上方式实现自动批量markdown图片处理工作，以方便之后把markdown内容在网络传播。
+
+## 注意事项
+
+- 本程序不会改变原始markdown文件，请放心使用。
+- 对于已经生成副本的原始文件，本程序不会再次处理，如果需要重新生成副本，请手动删除相应的已生成副本。
+- 本程序依赖于`sm.ms`图床，请自行注册账号并生成token。
+- 因为`sm.ms`图床接口有调用限制，如果出现图片上传出错的情况，可能是上传频繁导致，请等待1分钟以上时间后重新使用本程序。
+- 目前本程序只支持windows。
+- `sm.ms`国内访问不算友好，生成的markdown拷贝立即在网络上发布可能会显示防盗链等图片挂掉的情况，那是因为国内CDN比较慢，等一段时间就好了。
+
+## 安装
+
+```shell
+pip install markdown-img-icexmoon
+```
+
+## 更新
+
+```shell
+pip install --upgrade markdown-img-icexmoon
+```
+
+## 使用方式
+
+1. 使用CMD定位到将要处理的markdown文件目录。
+2. 执行`python -m markdown_img`。
+3. 第一次运行程序会提示你输入图床token。
+4. 输入后再次执行步骤2。
+5. 等待处理。
+6. 完毕后查看`工作目录/markdown_img`目录。
+
+> - 图床token存储在程序所在目录的`smms_token.config`文件中，如果需要修改的可以自行修改，也可以删除该配置文件后重新运行程序输入。
+> - 稍后会丰富并完善程序的相关命令参数。
+
+
+
+

build/lib/markdown_img/__init__.py

@@ -0,0 +1,8 @@
+import os
+import sys
+part = __file__.rpartition('\\')
+packageDirPath = part[0]
+sys.path.append(packageDirPath)
+from main import Main
+mainProcess = Main()
+mainProcess.main()

build/lib/markdown_img/config.py

@@ -0,0 +1,51 @@
+import os
+from user_exception import UserException
+
+
+class Config():
+    smmsTokenFile = ""
+
+    def __init__(self):
+        pass
+
+    def getCurrentDirPath(self):
+        part = __file__.rpartition('\\')
+        return part[0]
+
+    def getCurrentWorkDirPath(self):
+        return os.getcwd()
+
+    def getMarkdownImgDirPath(self):
+        '''返回当前工作目录对应的markdown_img目录'''
+        markdownImgDirPath = self.getCurrentWorkDirPath()+"\\markdown_img"
+        if not os.path.exists(markdownImgDirPath):
+            os.mkdir(markdownImgDirPath)
+        return markdownImgDirPath
+
+    def getSmmsTokenFile(self):
+        if Config.smmsTokenFile == "":
+            Config.smmsTokenFile = self.getCurrentDirPath()+'\\smms_token.config'
+        return Config.smmsTokenFile
+
+    def getSmmsToken(self):
+        if not os.path.exists(self.getSmmsTokenFile()):
+            raise UserException(UserException.CODE_NO_CONFIG)
+        configFileOpen = open(file=self.getSmmsTokenFile(), mode='r')
+        token = configFileOpen.readline()
+        configFileOpen.close()
+        if len(token) <= 4:
+            raise UserException(UserException.CODE_NO_CONFIG)
+        token = token[0:len(token)-1]
+        return token
+
+    def writeSmmsToken(self, token: str):
+        with open(file=self.getSmmsTokenFile(), mode='w') as configFileOpen:
+            print(token, file=configFileOpen)
+
+    def getErrorLogFilePath(self):
+        return self.getCurrentDirPath()+'\\error.log'
+
+    def writeErrorLog(self, msg: str):
+        errorLogFilePath = self.getErrorLogFilePath()
+        with open(file=errorLogFilePath, mode='a', encoding='UTF-8') as logOpen:
+            print(msg, file=logOpen)

build/lib/markdown_img/main.py

@@ -0,0 +1,109 @@
+from config import Config
+import os
+from smms_img import SmmsImg
+from user_exception import UserException
+
+
+class Main():
+
+    def __init__(self):
+        pass
+
+    def isMarkdownFile(self, fileName: str):
+        filePart = fileName.rpartition('.')
+        fileExt = filePart[-1]
+        return fileExt == 'md'
+
+    def isOrigMdFile(self, fileName: str):
+        '''判断是否为原始markdown文件'''
+        if not self.isMarkdownFile(fileName):
+            return False
+        # 检查文件后缀是否为_image
+        specialMark = "_image"
+        filePart = fileName.rpartition('.')
+        # 如果文件名长度过小，肯定是原始文件
+        if len(filePart[0]) <= len(specialMark):
+            return True
+        # 后缀是否能完全匹配
+        if filePart[0].endswith(specialMark):
+            return False
+        return True
+
+    def getCopyFileName(self, fileName: str):
+        filePart = fileName.rpartition('.')
+        fileExt = filePart[-1]
+        newFileName = filePart[0]+'_image.'+fileExt
+        return newFileName
+
+    def getCopyFilePath(self, fileName: str):
+        copyFileName = self.getCopyFileName(fileName)
+        SysConfig = Config()
+        return SysConfig.getMarkdownImgDirPath()+'\\'+copyFileName
+
+    def findLocalImageFile(self, line: str, localImages: set):
+        '''递归查找某段字符串中中括号包裹的内容是否为本地图片'''
+        linePart = line.partition('(')
+        if len(linePart[2]) > 0:
+            secondPart = linePart[2].partition(')')
+            content = secondPart[0]
+            if len(content) > 0:
+                # print(content)
+                if content.endswith('.png') and os.path.exists(content):
+                    localImages.add(content)
+                    self.findLocalImageFile(content, localImages)
+
+    def dealMdFile(self, mdFile: str):
+        imgDict = dict()
+        localImages = set()
+        # 逐行扫描，查找本地图片
+        with open(file=mdFile, mode='r', encoding='UTF-8') as fopen:
+            for line in fopen:
+                # 去除行尾的换行
+                subLine = line[0:len(line)-1]
+                self.findLocalImageFile(subLine, localImages)
+        # 上传本地图片，建立图片映射表
+        imgServer = SmmsImg()
+        imgServer.multiUploadImage(list(localImages), imgDict)
+        # 替换本地图片
+        # copyFileName = self.getCopyFileName(mdFile)
+        copyFilePath = self.getCopyFilePath(mdFile)
+        copyFileOpen = open(file=copyFilePath, mode='w', encoding='UTF-8')
+        with open(file=mdFile, mode='r', encoding='UTF-8') as fwrite:
+            for line in fwrite:
+                for localImg, webImg in imgDict.items():
+                    line = line.replace(localImg, webImg)
+                copyFileOpen.write(line)
+        copyFileOpen.close()
+
+    def dealUserException(self, userExp: UserException):
+        sysConfig = Config()
+        if userExp.getErrorCode() == UserException.CODE_NO_CONFIG:
+            token = input("缺少你的sm.ms访问令牌，请输入：")
+            sysConfig.writeSmmsToken(token)
+            print("访问令牌已保存，请重新运行程序")
+            exit()
+        elif userExp.getErrorCode() == UserException.CODE_UPLOAD_ERROR:
+            print("上传图片到sm.ms失败，请检查日志文件", sysConfig.getErrorLogFilePath())
+            exit()
+        else:
+            print("未定义错误，请联系开发者")
+            exit()
+
+    def main(self):
+        # 检索当前目录中的markdown文件
+        for dir in os.listdir():
+            # print(dir)
+            if os.path.isfile(dir):
+                if self.isOrigMdFile(dir):
+                    # 复制一份拷贝，如果有，则不覆盖
+                    # copyFileName = self.getCopyFileName(dir)
+                    copyFilePath = self.getCopyFilePath(dir)
+                    if not os.path.exists(copyFilePath):
+                        # 对拷贝进行处理
+                        try:
+                            self.dealMdFile(dir)
+                        except UserException as e:
+                            self.dealUserException(e)
+                        print("已成功处理markdown文件", dir)
+        print("所有markdown文档已处理完毕")
+        exit()

build/lib/markdown_img/smms_img.py

@@ -0,0 +1,44 @@
+from config import Config
+from user_exception import UserException
+import requests
+
+
+class SmmsImg():
+    def __init__(self):
+        self.sysConfig = Config()
+        pass
+
+    def uploadToSmms(self, path: str) -> str:
+        '''上传本地图片到smms,并返回网络图片地址'''
+        token = self.sysConfig.getSmmsToken()
+        headers = {'Authorization': token}
+        files = {'smfile': open(path, 'rb')}
+        url = 'https://sm.ms/api/v2/upload'
+        res = requests.post(url, files=files, headers=headers).json()
+        if res['success']:
+            return res['data']['url']
+        elif res['code'] == 'image_repeated':
+            return res['images']
+        else:
+            pass
+        # logOpen = open(file='upload.log', mode='a')
+        # print(res, file=logOpen)
+        # logOpen.close()
+        self.sysConfig.writeErrorLog(str(res))
+        return False
+
+    def multiUploadImage(self, images: list, results: dict):
+        '''批量上传图片'''
+        if len(images) <= 10:
+            for localImg in images:
+                webImage = self.uploadToSmms(localImg)
+                if webImage == False:
+                    # print("文件上传出错")
+                    # exit()
+                    raise UserException(
+                        UserException.CODE_UPLOAD_ERROR, "文件上传出错")
+                else:
+                    results[localImg] = webImage
+        else:
+            self.multiUploadImage(images[0:10], results)
+            self.multiUploadImage(images[10:len(images)], results)

build/lib/markdown_img/user_exception.py

@@ -0,0 +1,14 @@
+class UserException (Exception):
+    # 缺少配置文件
+    CODE_NO_CONFIG = 1
+    CODE_UPLOAD_ERROR = 2
+
+    def __init__(self, errorCode: int, errorMsg: str = ""):
+        self.errorCode = errorCode
+        self.errorMsg = errorMsg
+
+    def getErrorCode(self):
+        return self.errorCode
+
+    def getErrorMsg(self):
+        return self.errorMsg

dist/markdown-img-icexmoon-0.0.5.tar.gz

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"