Github目录生成器 - Python小工具

简述

写这个工具主要目的在于减少工作量,Bear在写GitBook的时候,发现对应目录一个一个写进去,非常繁琐,而且最近在学习Python,所以,手痒之下写了一个目录生成的小工具。

工具使用

本身工具并不复杂,主要实现功能接受一个Github中的raw版本的Url,然后打印自动生成对应文件的MarkDown语法的目录。

  • 第一步
    点击对应Github中目标文件raw的按钮。

  • 第二步
    获取原始的MarkDown文件,复制对应url。

  • 第三步
    获取工具,同第一步,可以使用wget工具从Github上获取源代码。

  • 第四步
    运行。(具体操作,也可以看代码注释说明)

模块设计

本身工具比较简单,主要涉及的功能是:

  1. 利用Http协议从url中获取Github文件;
    通过Python提供的urllib2库,可以直接获取Github上的文件。
  2. 从文件中提取目录信息。
    根据MarkDown语法,目录是带“#”,目录内容空格间隔。
    ps:其中,较为繁琐的是,目录中如果出现“!@#$”等字符,Github有特定的转换语法(bear是一个个试出来的,函数valueToUrl),此外,还有相同目录内容的情况,也会有处理(函数 getSameContentNum)。
  3. 将目录信息转化为最终目录的语法。
    同样也是根据MarkDown语法。

结束语

由于第一次写工具,如有不当的地方,或者程序有bug,请指出,不胜感激。

posted @ 2017-10-18 09:18  Winston_bear  阅读(787)  评论(0编辑  收藏  举报