Python3 将 Gitee issue 导出到 markdown

前言
既然G1、G2都写了脚本，那国内的gitee，也写一个吧。核心的方法是用gitee 提供的api接口来获取issue和comments里的markdown字符串。

• 支持 私有 仓
• 支持 comments
• 支持 labels

gitee api 文档：https://gitee.com/api/v5/swagger

小可爱们【转载请注明出处】谢谢。

1 获取token

首先要获取token，获取地址：https://gitee.com/profile/personal_access_tokens/new

将projects、issues、notes 选上。当然你也可以全选。

2 使用代码下载issue

换上自己的 user、repo、token、out_dir ，然后就可以愉快地用shell下载了。
脚本是这样子的：

python3 issue_to_markdown.py -u user -r repo -t token -o out_dir

也可以在 issue_to_markdown.py 的54行，写上 user、repo、token、out_dir的值，就不需要给参数了。

代码文件： issue_to_markdown.py

from tqdm import tqdm
import os
import argparse
import codecs
import json
import re
import requests
requests.session().keep_alive = False  # 及时释放


def get_info(api_url, token):
    headers = {'Private-Token': "%s" % token}
    r = requests.get(api_url, headers=headers)
    ret = json.loads(r.text)
    # print(ret)
    if r.status_code > 300:
        print('error %s', r.text)
        return False
    return ret


def to_markdown(page, coms):
    mk = '# ' + page['title'] + '\n'
    mk += "created_at: "+page['created_at']+"\n"
    mk += "updated_at: "+page['updated_at']+"\n"

    labels = "label: "
    for idx, item in enumerate(page['labels']):
        if (idx+1) == len(page['labels']):
            labels += item['name']+'\n'
        else:
            labels += item['name']+','
    mk += labels+'\n'

    mk += page['body']+'\n'

    for com in coms:
        # mk += "\n---\n"
        # mk += "created_at: "+com['created_at'] + \
        #     ", updated_at: "+com['updated_at']+"\n"
        mk += com['body']+"\n"
    return mk


if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('-u', '--username', help="gitee account username")
    parser.add_argument('-r', '--repo', help="gitee account repo")
    parser.add_argument('-t', '--token', help="gitee personal access token")
    parser.add_argument('-o', '--dir', help="out put dir")

    args = parser.parse_args()

    # args.username = ""
    # args.repo = ""
    # args.token = ""
    # args.dir = ""

    if not os.path.exists(args.dir):
        os.makedirs(args.dir)

    issue_url = "https://gitee.com/api/v5/repos/%s/%s/issues" % (
        args.username, args.repo)

    ret = get_info(issue_url, args.token)
    for page in tqdm(ret):
        coms = []
        if page['comments'] > 0:
            coms = get_info(page['comments_url'], args.token)
        mk = to_markdown(page, coms)

        # save
        filename = page['created_at'].split('T')[0]+','+page['title']+'.md'
        filename = re.sub(r'[/:*?"<>|]', " ", filename)  # check filename
        filename = os.path.join(args.dir, filename)

        with codecs.open(filename, 'w', 'utf-8') as file:
            file.write(mk)

3 用issue写作

记得用 ## 作为小节标题哈，在导出的文档里主次清晰，不乱的。

4 结果

下面是导出数据的结果，md文件的标题是 时间+issue title.md。

再见！！！

笔者还写了，Github issue 导出到markdown
https://blog.csdn.net/github_25176023/article/details/105725979

还写了，Gitlab issue 导出到markdown
https://blog.csdn.net/github_25176023/article/details/105737191

小可爱们，点赞收藏分享走一波？