pyquickhelper 1.7.2581

Various functionalities: folder synchronization, simple logging function, helpers to generate documentation with sphinx, sphinx extension, to run a command line, to run a notebook...

README

Links:

• GitHub/pyquickhelper

• documentation

• Blog

Functionalities

• simple forms in notebooks

• help generation including notebook conversion

• folder synchronization

• logging

• help running unit tests

• simple server to server sphinx documentation

• file compression, zip, gzip, 7z

• helpers for ipython notebooks (upgrade, offline run)

• parser to quickly add a magic command in a notebook

• Sphinx directives to integrate a blogpost in the documentation

• mechanism to add forms in notebooks

Design

This project contains the following folders:

• a source folder: src

• a unit test folder: _unittests, go to this folder and run run_unittests.py

• a folder: _doc, it will contain the documentation, a subfolder _doc/sphinxdox/source/blog contains blog post to communicate on the module

• a file setup.py to build and to install the module, if the source were retrieve from GitHub, the script can also be called with the following extra options (python setup.py <option>): * clean_space: remove extra spaces in the code * build_sphinx: builds the documentation * unittests: run the unit tests, compute the code coverage

• a script build_script.bat which produces many script on Windows to easily run the setup, generate the documentation, run the unit tests.

Examples

Convert a notebook into slides:

from pyquickhelper.helpgen import nb2slides
nb2slides("nb.ipynb", "convert.slides.html")

Merge two notebooks:

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)

Run a notebook:

from pyquickhelper.ipythonhelper import run_notebook
run_notebook("source.ipynb", working_dir="temp",
            outfilename="modified.ipynb",
            additional_path = [ "c:/temp/mymodule/src" ] )

Run a command line program:

from pyquickhelper.loghelper import run_cmd
out,err = run_cmd("python setup.py install", wait=True)

A sphinx extension to generate python documentation from a script:

.. runpython::
    :showcode:

    import sys
    print("sys.version_info=", str(sys.version_info))

History

current - 2018-05-08 - 0.00Mb

• 140: modify assertEqualArray to allow small different (assert_almost_equal) (2018-05-07)

• 138: retrieve past issues in history.rst (2018-05-06)

• 139: update to python-jenkins 1.0.0 (2018-05-05)

1.7.2569 - 2018-05-01 - 1.99Mb

• 137: fix bug in bug HTML output (aggregated pages) (2018-04-29)

• 136: add parameter create_dest to synchronize_folder (2018-04-29)

1.7.2560 - 2018-04-22 - 1.99Mb

• 135: fix for sphinx 1.7.3 (circular reference) (2018-04-22)

• 134: allow url in video sphinx extension (2018-04-22)

• 133: add a collapsible container, adapt it for runpython (2018-04-22)

• 132: catch warning in run_python_script output, use redirect_stdout (2018-04-21)

• 131: remove warning in runpython (2018-04-21)

• 130: add plot output for runpython (2018-04-21)

• 129: implement an easy way to profile a function in unit test (2018-04-19)

• 128: fix issue in enumerate_pypi_versions_date (2018-04-14)

• 127: update to pip 10 (many API changes) (2018-04-14)

• 126: remove dependency on flake8, use pycodestyle (2018-04-13)

• 125: fix sharenet for rst format (2018-04-05)

• 124: add CodeNode in rst builder (2018-04-05)

• 123: fix style for blogpostagg, remove inserted admonition (2018-04-05)

• 122: fix notebook name when converting into rst (collision with html) (2018-04-05)

• 121: extend list of functions in ExtTestCase (NotEqual, Greater(strict=True), NotEmpty (2018-04-01)

• 120: add _fieldlist_row_index if missing in HTMLTranslatorWithCustomDirectives (2018-04-01)

• 119: collision with image names in notebooks converted into rst (2018-03-29)

• 117: bug with nbneg_pattern, check unit test failing due to that (2018-03-26)

• 116: add tag .. raw:: html in notebook converted into rst (2018-03-26)

• 114: automatically builds history with release and issues + add command history in setup (2018-03-24)

• 111: enable manual snippet for notebook, repace add_notebook_menu by toctree in sphinx (2018-03-20)

• 113: propose a fix for a bug introduced by pip 9.0.2 (2018-03-19)

• 112: allow to set custom snippets for notebooks (2018-03-15)

• 109: run javascript producing svg and convert it into png (2018-03-15)

• 107: convert svg into png for notebook snippets (2018-03-12)

• 108: add command lab, creates a script to start jupyter lab on notebook folder (2018-03-10)

• 106: replace pdflatex by xelatex to handle utf-8 (2018-03-03)

• 104: implement visit, depart for pending_xref and rst translator (2018-03-01)

• 103: fix import issue for Sphinx 1.7.1 (2018-03-01)

• 102: fix sphinx command line (2018-02-24)

1.6.2413 - 2018-02-13 - 1.98Mb

• 100: fix indentation when copying the sources in documentation repository (2018-02-04)

• 99: bug with galleries of examples with multiple subfolders (2018-01-30)

1.5.2275 - 2017-11-28 - 0.50Mb

1.4.1533 - 2016-09-10 - 0.36Mb