pyquickhelper 1.3.1110

Various functionalities: folder synchronization, a logging function, helpersto generate documentation with sphinx, generation of code for Python 2.7 from Python 3

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.

Versions, Changes

• 1.3 - 2016/??/??

  • add: add function check_readme_syntax to check the syntax of file readme.rst (pipy uses an earlier version of docutils)

  • fix: fix a bug in function compare_module_version

  • add: new function find_notebook_kernel and get_notebook_kernel to find installed kernels on a computer

  • change: class NotebookRunner now allows to specify a kernel name and to add extra parameters on the command line, this change was propagated to function find_notebook_kernel, get_notebook_kernel

  • change: update script generated by the module to start using jupyter short cuts instead of ipython

  • add: function to install notebook extension and to load them (see notebook section)

  • add: function install_jupyter_kernel to install a kernel for a notebook

  • add: add a filtering option to remove file from the coverage report

  • fix: run unit tests having SKIP in their names (it was LONG before)

  • add: add functions to run before and after the documentation generation (to add extra files, to remove, to modify, …)

  • change: function rst2html now interprets sphinx directives and not only directives

  • add: parameters no_eval, eval_type to method add_argument for parsers used for magic command lines, it avoids the value of the parameter to be considered as a python expression or enforce the type of the returned value

  • change: update the module to handle Python 3.5

  • add: add method delete_all_jobs to class JenkinsExt

  • change: refactor class JenkinsExt to handle more python versions

  • update: javascript producing the automated menu in a notebook was adapted to be efficient in a RST converted notebook

  • add: add script auto_cmd_copy_sphinx.bat which copies the documentation from _doc/sphinxdoc/build to dist

  • change: use local latex engine instead of matplotlib engine to convert formulas into images

  • add: catch exception SystemExit in method run_cmd if required

  • new: documentation builds a new page gathering all commands @NB

  • new: add function to encrypt and decrypt files using AES and pycrypto

  • new: add class EncryptedBackup to backup many files into a remote folder in encrypted format

  • new: add command line encrypt, decrypt, encrypt_file, decrypt_file

  • new: add magic commands (notebooks) encrypt_file, decrypt_file

  • fix: the conversion of notebooks now requires require.js, the script is downloaded where it is needed by reveal.js

  • change: sphinx command runpython now processes Sphinx commands such as links, reference or titles

  • new: publish coverage report to codecov

  • new: function read_csv to read a dataframe from a zip file (disable in the recent version of pandas)

  • add: catches stdout, stderr in function main_wrapper_tests

  • change: disabled pieces of code for the automated generation of documentation can be enabled back when running extension runpython

  • add: add parameter setsysvar to function run_python_script and directive runpython

  • new: custom role and directive sharenet to share a page on networks (facebook, twitter, linkedin)

  • new: custom role bigger to add bigger text in a sphinx documentation

  • new: blog post add share buttons to share the link with twitter, facebook or linkedin (by default), to disable it, set variable sharepost to None in sphinx configuration

  • add: add option process to sphinx custom directive runpython

  • add: add parameter custom_style to the default configuration