跳转到主要内容

各种功能:文件夹同步、简单的日志功能、使用sphinx生成文档的辅助工具、sphinx扩展、运行命令行、运行笔记本...

项目描述

https://github.com/sdpython/pyquickhelper/blob/master/_doc/sphinxdoc/source/_static/project_ico.png?raw=true

pyquickhelper:许多事情的自动化

Build status Build Status Windows https://circleci.com/gh/sdpython/pyquickhelper/tree/master.svg?style=svg https://dev.azure.com/xavierdupre3/pyquickhelper/_apis/build/status/sdpython.pyquickhelper https://badge.fury.io/py/pyquickhelper.svg MIT License https://codecov.io/github/sdpython/pyquickhelper/coverage.svg?branch=master GitHub Issues Codacy Badge Notebook Coverage Downloads Forks Stars size

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 (3.1 MB 查看哈希

上传时间

构建分发

pyquickhelper-1.12.3823-py3-none-any.whl (3.3 MB 查看哈希

上传时间 Python 3

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面