各种功能:文件夹同步、简单的日志功能、使用sphinx生成文档的辅助工具、sphinx扩展、运行命令行、运行笔记本...
项目描述
pyquickhelper:许多事情的自动化
pyquickhelper 用于自动化文档的发布,如自动化 Jenkins,将笔记本转换为多种格式,扩展 Sphinx 以自定义扩展……它假定项目是按照与这个相同的模板组织的。
功能
笔记本中的简单表单
帮助生成,包括笔记本转换
文件夹同步
日志
帮助运行单元测试
简单的服务器到服务器sphinx文档
文件压缩,zip,gzip,7z
ipython笔记本的辅助工具(升级,离线运行)
解析器,快速在笔记本中添加魔术命令
Sphinx指令以在文档中集成博客文章
在笔记本中添加表单的机制
设计
此项目包含以下文件夹
源文件夹: src
单元测试文件夹: _unittests,进入此文件夹并运行 run_unittests.py
文件夹: _doc,它将包含文档,子文件夹 _doc/sphinxdox/source/blog 包含有关模块的博客文章
一个用于构建和安装模块的文件 setup.py,如果从GitHub检索源代码,脚本也可以使用以下额外选项进行调用(python setup.py <option>):* clean_space:删除代码中的额外空格 * build_sphinx:构建文档 * unittests:运行单元测试,计算代码覆盖率
一个名为 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)
一个sphinx扩展,可以从脚本生成Python文档
.. runpython:: :showcode: import sys print("sys.version_info=", str(sys.version_info))
链接
项目详情
关闭
pyquickhelper-1.12.3823.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | db2bdf4f27542aa2097d3ce74908e8612b7ea2e40aa46b61863b293c33e9bc35 |
|
MD5 | 87475a4fabdb56a585f85df10e07765f |
|
BLAKE2b-256 | b45e019b51cd63151d249e75b68b144a7153537a606d9dd9b93e9077aa9ec762 |
关闭
pyquickhelper-1.12.3823-py3-none-any.whl的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | a183c0c2202198387be79810396f282d07ecc2ecf77b95a17a3dbac12dd3c326 |
|
MD5 | f8367425df7a04f5999cd88946acd210 |
|
BLAKE2b-256 | 3bff8ab2eb97c228b1877fc0a6317b20c6cc2bab5a166e70d500fff823c907a1 |