各种功能:文件夹同步、简单的日志记录功能、使用sphinx生成文档的帮助程序、sphinx扩展、运行命令行、运行笔记本…
pyquickhelper的Python项目详细描述
pyquickhelper:许多事情的自动化
<<功能
- 笔记本中的简单表单
- 帮助生成,包括笔记本转换
- 文件夹同步
- 日志记录
- 帮助运行单元测试
- 简单的服务器到服务器sphinx文档
- 文件压缩,zip,gzip,7z
- iPython笔记本电脑的帮助程序(升级、脱机运行)
- 用于在笔记本中快速添加魔术命令的解析器
- sphinx指令将blogpost集成到文档中
- 在笔记本中添加表单的机制
设计
此项目包含以下文件夹:
- 源文件夹: src
- 单元测试文件夹: \u unittests ,转到该文件夹并运行 run\u unittests.py
- 一个文件夹: \u doc ,它将包含文档,一个子文件夹 \u doc/sphinxbox/source/blog 包含blog post 在模块上通信
- 一个文件 setup.py 来构建和安装模块,如果源代码是从github检索的, 还可以使用以下附加选项调用脚本( python setup.py<;option>; ): *清除空间:删除代码中的多余空间 *build_sphinx:生成文档 *unit tests:运行单元测试,计算代码覆盖率
- 一个脚本 build_script.bat 可以在windows上生成许多脚本来轻松运行安装程序, 生成文档,运行单元测试。
示例
将笔记本转换为幻灯片:
from pyquickhelper.helpgen import nb2slides nb2slides("nb.ipynb", "convert.slides.html")
合并两个笔记本:
from pyquickhelper.ipythonhelper import read_nb nb1 = read_nb("<file1>", kernel=False) nb2 = read_nb("<file2>", kernel=False) nb1.merge_notebook(nb2) nb1.to_json(outfile)
运行笔记本:
from pyquickhelper.ipythonhelper import run_notebook run_notebook("source.ipynb", working_dir="temp", outfilename="modified.ipynb", additional_path = [ "c:/temp/mymodule/src" ] )
运行命令行程序:
from pyquickhelper.loghelper import run_cmd out,err = run_cmd("python setup.py install", wait=True)
从脚本生成python文档的sphinx扩展:
.. runpython:: :showcode: import sys print("sys.version_info=", str(sys.version_info))