Modules

Summary

module truncated documentation
__init__ module pyquickhelper Module pyquickhelper. Helpers to produce documentation, test notebooks, walk through files, sphinx extension, jenkins helpers… source on GitHub
__init__ module pyquickhelper.benchhelper Shortcuts to benchhelper source on GitHub
__init__ module pyquickhelper.cli Shortcuts to cli. source on GitHub
__init__ module pyquickhelper.filehelper Shortcuts to filehelper source on GitHub
__init__ module pyquickhelper.helpgen Subpart related to the documentation generation. source on GitHub
__init__ module pyquickhelper.imghelper Shortcuts to imghelper. source on GitHub
__init__ module pyquickhelper.ipythonhelper Shortcuts to ipythonhelper source on GitHub
__init__ module pyquickhelper.jenkinshelper shortcuts to jenkinshelper source on GitHub
__init__ module pyquickhelper.loghelper Shortcuts to loghelper functions source on GitHub
__init__ module pyquickhelper.pandashelper @bried shortcuts to pandashelper source on GitHub
__init__ module pyquickhelper.pycode shortcuts fror pycode source on GitHub
__init__ module pyquickhelper.serverdoc shortcuts for documentation_server source on GitHub
__init__ module pyquickhelper.sphinxext Subpart related to sphinx extensions .. todoext:: :title: add directive for a sortable table :tag: enhancement :issue: 27 Based on slickgrid. source on GitHub
__init__ module pyquickhelper.sphinxext.revealjs sphinxjp.themes.revealjs ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :author: tell-k <ffk2005@gmail.com> :copyright: tell-k. All Rights Reserved. Taken from github/return42. source on GitHub
__init__ module pyquickhelper.sphinxext.sphinximages Imported from sphinxcontrib-images which was updated for a long time. The package was modified. source on GitHub
__init__ module pyquickhelper.sphinxext.sphinximages.sphinxcontrib_images_lightbox2 Ressource for backend lightbox2 for directive image. source on GitHub
__init__ module pyquickhelper.sphinxext.sphinximages.sphinxtrib Shortcuts to images. source on GitHub
__init__ module pyquickhelper.texthelper shortcuts to text source on GitHub
__main__ module pyquickhelper.__main__ Implements command line python -m pyquickhelper <command> <args>. .. versionadded:: 1.8 source on GitHub
_fake_function_to_documentation module pyquickhelper.helpgen._fake_function_to_documentation This file is to compare different documentation style. source on GitHub
_my_doxypy module pyquickhelper.helpgen._my_doxypy doxypy is an input filter for Doxygen. It preprocesses python files so that docstrings of classes and functions are reformatted into Doxygen-conform documentation blocks. In order to make Doxygen preprocess files through doxypy, simply add the following lines to your Doxyfile: - FILTER_SOURCE_FILES = YES - INPUT_FILTER = "python /path/to/doxypy.py" source on GitHub
_nbconvert_config module pyquickhelper.helpgen._nbconvert_config Custom preprocessor, see custom_preprocessor source on GitHub
_nbconvert_preprocessor module pyquickhelper.helpgen._nbconvert_preprocessor Custom configuration for nbconvert, see custom_preprocessor source on GitHub
_private_for_unittest module pyquickhelper.sphinxext._private_for_unittest Used only for unit test purpose. source on GitHub
_pylint_common module pyquickhelper.pycode._pylint_common Check code style. .. versionadded:: 1.8 source on GitHub
_sphinx_common_builder module pyquickhelper.sphinxext._sphinx_common_builder Common functions for Sphinx writers. source on GitHub
anyfhelper module pyquickhelper.filehelper.anyfhelper Various helpers about files source on GitHub
backend module pyquickhelper.sphinxext.sphinximages.backend Backend API for sphinx directive image. source on GitHub
benchmark module pyquickhelper.benchhelper.benchmark Helpers to benchmark something source on GitHub
blog_helper module pyquickhelper.pycode.blog_helper Function which starts a server to grab and read blog post for a mobule based on pyqcuikhelper design. It relies on module pyrsslocal. source on GitHub
blog_post module pyquickhelper.sphinxext.blog_post Helpers to process blog post included in the documentation. source on GitHub
blog_post_list module pyquickhelper.sphinxext.blog_post_list Helpers to build RST extra files inserted in the documentation. source on GitHub
bokeh_plot module pyquickhelper.sphinxext.bokeh.bokeh_plot Modified version of bokeh_plot.py, LICENSE. Include bokeh plots in Sphinx HTML documentation. For other output types, the placeholder text [graph] will be generated. The bokeh-plot directive can be used by either supplying, a path to a source file as the argument to the directive:: .. bokeh-plot:: path/to/plot.py .. note:: .py scripts are not scanned automatically! In order to include certain directories into .py scanning process use following directive in sphinx conf.py file: bokeh_plot_pyfile_include_dirs = [“dir1”,”dir2”] Inline code as the content of the directive:: .. bokeh-plot:: from bokeh.plotting import figure, output_file, show output_file(“example.html”) x = [1, 2, 3, 4, 5] y = [6, 7, 6, 4, 5] p = figure(title=”example”, plot_width=300, plot_height=300) p.line(x, y, line_width=2) p.circle(x, y, size=10, fill_color=”white”) show(p) This directive also works in conjunction with Sphinx autodoc, when used in docstrings. The bokeh-plot directive accepts the following options: source-position : enum(‘above’, ‘below’, ‘none’) Where to locate the the block of formatted source code (if anywhere). linenos : flag Whether to display line numbers along with the source. Examples ——– The inline example code above produces the following output: .. bokeh-plot:: from bokeh.plotting import figure, output_file, show output_file(“example.html”) x = [1, 2, 3, 4, 5] y = [6, 7, 6, 4, 5] p = figure(title=”example”, plot_width=300, plot_height=300) p.line(x, y, line_width=2) p.circle(x, y, size=10, fill_color=”white”) show(p) source on GitHub
buffered_flog module pyquickhelper.loghelper.buffered_flog Buffer as a logging function. source on GitHub
build_helper module pyquickhelper.pycode.build_helper Produces a build file for a module following pyquickhelper design. source on GitHub
build_rss module pyquickhelper.sphinxext.build_rss Buid the RSS stream. source on GitHub
call_setup_hook module pyquickhelper.pycode.call_setup_hook Helper for the setup. source on GitHub
ci_helper module pyquickhelper.pycode.ci_helper Helpers for CI. source on GitHub
clean_helper module pyquickhelper.pycode.clean_helper Various function to clean files. source on GitHub
cli_helper module pyquickhelper.cli.cli_helper Automate the creation of a parser based on a function. source on GitHub
code_exceptions module pyquickhelper.pycode.code_exceptions exceptions raised in this subfolder source on GitHub
code_helper module pyquickhelper.pycode.code_helper Various function to clean the code. source on GitHub
code_helper module pyquickhelper.texthelper.code_helper Some functions about diacritics source on GitHub
compat module pyquickhelper.sphinxext.revealjs.compat sphinxjp.themes.revealjs.compat ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :author: tell-k <ffk2005@gmail.com> :copyright: tell-k. All Rights Reserved. source on GitHub
compression_helper module pyquickhelper.filehelper.compression_helper Functions about compressing files. source on GitHub
conf_path_tools module pyquickhelper.helpgen.conf_path_tools Looks for paths, Miktek, Graphviz… source on GitHub
convert_helper module pyquickhelper.loghelper.convert_helper Various functions about conversions. source on GitHub
coverage_helper module pyquickhelper.pycode.coverage_helper Publishing coverage source on GitHub
custom_log module pyquickhelper.loghelper.custom_log Creates a custom log (open a text file and flushes everything in it). source on GitHub
default_conf module pyquickhelper.helpgen.default_conf Default values for the Sphinx configuration. source on GitHub
default_filter_warning module pyquickhelper.pycode.default_filter_warning Function which filters ou warnings after running the unit test source on GitHub
default_regular_expression module pyquickhelper.pycode.default_regular_expression Regular expressions. source on GitHub
diacritic_helper module pyquickhelper.texthelper.diacritic_helper Some functions about diacritics source on GitHub
directives module pyquickhelper.sphinxext.revealjs.directives sphinxjp.themes.revealjs.directives ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :author: tell-k <ffk2005@gmail.com> :copyright: tell-k. All Rights Reserved. source on GitHub
documentation_link module pyquickhelper.sphinxext.documentation_link Automated link to documentation. source on GitHub
documentation_server module pyquickhelper.serverdoc.documentation_server This file defines a simple local server delivering generating documentation. source on GitHub
download_helper module pyquickhelper.filehelper.download_helper A function to download the content of a url. source on GitHub
encrypted_backup module pyquickhelper.filehelper.encrypted_backup Keeps an encrypted of personal data source on GitHub
encryption module pyquickhelper.filehelper.encryption Encryption functionalities. Inspired from AES encryption of files in Python with PyCrypto source on GitHub
encryption_cli module pyquickhelper.cli.encryption_cli encrypt and decrypt command lines source on GitHub
encryption_file_cli module pyquickhelper.cli.encryption_file_cli encrypt and decrypt command lines for just a file source on GitHub
excs module pyquickhelper.imghelper.excs Exceptions. .. versionadded:: 1.7 source on GitHub
fexceptions module pyquickhelper.filehelper.fexceptions exceptions source on GitHub
file_info module pyquickhelper.filehelper.file_info Defines class FileInfo source on GitHub
file_tree_node module pyquickhelper.filehelper.file_tree_node a node which contains a file or a folder source on GitHub
files_status module pyquickhelper.filehelper.files_status keep the status of a folder, assuming this folder is not moved source on GitHub
flog module pyquickhelper.loghelper.flog logging functionalities The function fLOG (or fLOG) is used to logged everything into a log file. :: from pyquickhelper.loghelper.flog import fLOG fLOG (OutputPrint = True) # the logs are also displayed in the output stream fLOG (LogPath = “…”) # chanages the path returned by GetPath fLOG (“un”, “deux”, 4, [“gt”]) # log everything in a log file from pyquickhelper.loghelper.flog import GetPath () print GetPath () # return the log path (file temp_log.txt) fLOG (LogPath = “c:/temp/log_path”) # change the log path, creates it if it does not exist .. warning:: This module inserts static variable in module sys. I was done to deal with several instances of the same module in earlier versions of python. source on GitHub
flog_fake_classes module pyquickhelper.loghelper.flog_fake_classes Exception specific to this module. source on GitHub
ftp_mock module pyquickhelper.filehelper.ftp_mock Mock FTP classes. source on GitHub
ftp_transfer module pyquickhelper.filehelper.ftp_transfer provides some functionalities to upload file to a website source on GitHub
ftp_transfer_files module pyquickhelper.filehelper.ftp_transfer_files Class to transfer files to a website using FTP, it only transfers updated files source on GitHub
ftp_transfer_mock module pyquickhelper.filehelper.ftp_transfer_mock Mock class TransferFTP source on GitHub
github_api module pyquickhelper.loghelper.github_api Calls github API. source on GitHub
gitlab_helper module pyquickhelper.loghelper.repositories.gitlab_helper Wrapper around GitLab API. source on GitHub
grid_benchmark module pyquickhelper.benchhelper.grid_benchmark Grid benchmark. source on GitHub
help_usage module pyquickhelper.helpgen.help_usage Help messages. source on GitHub
helpgen_exceptions module pyquickhelper.helpgen.helpgen_exceptions Exception raised by the automated documentation source on GitHub
history_helper module pyquickhelper.loghelper.history_helper @helper Build history for a module. .. versionadded:: 1.7 source on GitHub
html_forms module pyquickhelper.ipythonhelper.html_forms Some functions to interact better with Notebook source on GitHub
html_helper module pyquickhelper.texthelper.html_helper Some functions about HTML source on GitHub
images module pyquickhelper.sphinxext.sphinximages.sphinxtrib.images Sphinx extension for images. source on GitHub
import_object_helper module pyquickhelper.sphinxext.import_object_helper Defines a sphinx extension which if all parameters are documented. source on GitHub
insetup_helper module pyquickhelper.pycode.insetup_helper Function to use inside setup.py source on GitHub
install_custom module pyquickhelper.helpgen.install_custom Various function to install some application such as pandoc. source on GitHub
install_js_dep module pyquickhelper.helpgen.install_js_dep Install javascript dependencies for the documentation generation. source on GitHub
interact module pyquickhelper.ipythonhelper.interact To add interactive widgets in a notebook and connect it to Python function, Source: https://github.com/jakevdp/ipywidgets, the module was modified for Python 3 See notebook Having a form in a notebook. Copyright (c) 2013, Jake Vanderplas All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the {organization} nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. source on GitHub
internet_helper module pyquickhelper.filehelper.internet_helper Gather functions about downloading from internet, … source on GitHub
jenkins_exceptions module pyquickhelper.jenkinshelper.jenkins_exceptions Jenkins exceptions source on GitHub
jenkins_helper module pyquickhelper.jenkinshelper.jenkins_helper Helpers to prepare a local Jenkins server. source on GitHub
jenkins_server module pyquickhelper.jenkinshelper.jenkins_server Extends Jenkins Server from python-jenkins. source on GitHub
jenkins_server_template module pyquickhelper.jenkinshelper.jenkins_server_template Job templates. source on GitHub
js_helper module pyquickhelper.imghelper.js_helper Helpers around images and javascript. See also: * pyduktape * Python Mini Racer * python-requirejs .. versionadded:: 1.7 source on GitHub
kindofcompletion module pyquickhelper.ipythonhelper.kindofcompletion A custom way to add auto completion to IPython source on GitHub
lightbox2_backend module pyquickhelper.sphinxext.sphinximages.sphinxcontrib_images_lightbox2.lightbox2_backend Defines the backend for directive image. source on GitHub
linux_scripts module pyquickhelper.pycode.linux_scripts Batch file use to automate some of the tasks (setup, unit tests, help, pypi). source on GitHub
magic_class module pyquickhelper.ipythonhelper.magic_class Magic command to handle files source on GitHub
magic_class_compress module pyquickhelper.ipythonhelper.magic_class_compress Magic command to handle files source on GitHub
magic_class_crypt module pyquickhelper.ipythonhelper.magic_class_crypt Magic command to handle files source on GitHub
magic_class_diff module pyquickhelper.ipythonhelper.magic_class_diff Magic command to handle files source on GitHub
magic_class_example module pyquickhelper.ipythonhelper.magic_class_example Example of a class which defines magic commands. source on GitHub
magic_parser module pyquickhelper.ipythonhelper.magic_parser Magic parser to parse magic commands source on GitHub
markdown_helper module pyquickhelper.helpgen.markdown_helper Helpers for markdown functionalities, it requires dependencies on mistune. source on GitHub
notebook_exception module pyquickhelper.ipythonhelper.notebook_exception Some automation helpers about notebooks source on GitHub
notebook_exporter module pyquickhelper.helpgen.notebook_exporter Customer notebook exporters. .. versionadded:: 1.7 source on GitHub
notebook_helper module pyquickhelper.ipythonhelper.notebook_helper Some automation helpers about notebooks source on GitHub
notebook_runner module pyquickhelper.ipythonhelper.notebook_runner Modified version of runipy.notebook_runner. source on GitHub
open_script_file module pyquickhelper.pycode.open_script_file A function to read a script and reading the encoding on the first line. source on GitHub
os_helper module pyquickhelper.loghelper.os_helper Helpers for module os. source on GitHub
pandoc_helper module pyquickhelper.helpgen.pandoc_helper Helpers to call pandoc and convert documents source on GitHub
pip_helper module pyquickhelper.pycode.pip_helper Helpers for pip Some links to look: * installing_python_packages_programatically.py * Calling pip programmatically source on GitHub
post_process module pyquickhelper.helpgen.post_process Contains the main function to generate the documentation for a module designed the same way as this one, generate_help_sphinx(). source on GitHub
post_process_custom module pyquickhelper.helpgen.post_process_custom Custom functions to post process latex output before compiling it. source on GitHub
pqh_exception module pyquickhelper.loghelper.pqh_exception logged exception By default, all exceptions are logged through the function fLOG (fLOG()). :: raise PQHException (“message”) source on GitHub
process_helper module pyquickhelper.loghelper.process_helper Helpers about processes. source on GitHub
process_notebook_api module pyquickhelper.helpgen.process_notebook_api Direct calls to IPython API without running a command line source on GitHub
process_notebooks module pyquickhelper.helpgen.process_notebooks Contains the main function to generate the documentation for a module designed the same way as this one, generate_help_sphinx(). source on GitHub
process_notebooks_cmd module pyquickhelper.helpgen.process_notebooks_cmd Calls nbconvert in command line for latex and pdf source on GitHub
process_sphinx_cmd module pyquickhelper.helpgen.process_sphinx_cmd Calls nbconvert in command line for latex and pdf source on GitHub
py3to2 module pyquickhelper.pycode.py3to2 Helper to convert a script written in Python 3 to Python 2 source on GitHub
pygit_helper module pyquickhelper.loghelper.repositories.pygit_helper Uses git to get version number. source on GitHub
pypi_helper module pyquickhelper.loghelper.pypi_helper Helpers to information for pypi version. source on GitHub
pyq_sync_cli module pyquickhelper.cli.pyq_sync_cli Wrapper function synchronize_folder() into a command line. source on GitHub
pyrepo_helper module pyquickhelper.loghelper.pyrepo_helper a repository class independent from the repository system (it will be guessed) source on GitHub
pysvn_helper module pyquickhelper.loghelper.repositories.pysvn_helper Gather all pysvn functionalities here. There might be some differences between SVN version, pysvn client version, TortoiseSVN version and Python. If such a case happens, most of the function will call svn using the command line. source on GitHub
pytest_helper module pyquickhelper.pycode.pytest_helper :epkg:`pytest` is sometimes slow. This file provides helpers to easily run test function. source on GitHub
readh module pyquickhelper.pandashelper.readh Various ways to import data into a dataframe source on GitHub
readme_helper module pyquickhelper.pycode.readme_helper Helpers about readme. source on GitHub
rst_converters module pyquickhelper.helpgen.rst_converters Helpers to convert docstring to various format. source on GitHub
run_cmd module pyquickhelper.loghelper.run_cmd Implements function run_cmd(). source on GitHub
run_notebook module pyquickhelper.ipythonhelper.run_notebook Functions to run notebooks. source on GitHub
server_helper module pyquickhelper.serverdoc.server_helper Helpers about a documentation. source on GitHub
setup_helper module pyquickhelper.pycode.setup_helper Helper for the setup source on GitHub
simplified_fct module pyquickhelper.cli.simplified_fct Simplified function versions. source on GitHub
sphinx_autosignature module pyquickhelper.sphinxext.sphinx_autosignature Defines a sphinx extension to describe a function, inspired from autofunction and AutoDirective. source on GitHub
sphinx_bigger_extension module pyquickhelper.sphinxext.sphinx_bigger_extension Defines a sphinx extension to display bigger text. source on GitHub
sphinx_blocref_extension module pyquickhelper.sphinxext.sphinx_blocref_extension Defines a sphinx extension to keep track of blocs such as examples, FAQ, … source on GitHub
sphinx_blog_extension module pyquickhelper.sphinxext.sphinx_blog_extension Defines blogpost directives. See Tutorial: Writing a simple extension, Creating reStructuredText Directives source on GitHub
sphinx_cmdref_extension module pyquickhelper.sphinxext.sphinx_cmdref_extension Defines a sphinx extension to keep track of cmd. source on GitHub
sphinx_collapse_extension module pyquickhelper.sphinxext.sphinx_collapse_extension Defines a sphinx extension to hide / unhide section of the HTML page. .. versionadded:: 1.7 source on GitHub
sphinx_docassert_extension module pyquickhelper.sphinxext.sphinx_docassert_extension Defines a sphinx extension which if all parameters are documented. source on GitHub
sphinx_doctree_builder module pyquickhelper.sphinxext.sphinx_doctree_builder Defines a sphinx extension to output sphinx doctree. .. versionadded:: 1.8 source on GitHub
sphinx_downloadlink_extension module pyquickhelper.sphinxext.sphinx_downloadlink_extension Defines a sphinx extension to show a link instead of downloading it. This extension does not work for Sphinx < 1.8. .. versionadded:: 1.8 source on GitHub
sphinx_epkg_extension module pyquickhelper.sphinxext.sphinx_epkg_extension Defines a way to reference a package or a page in this package. source on GitHub
sphinx_exref_extension module pyquickhelper.sphinxext.sphinx_exref_extension Defines a sphinx extension to keep track of ex. source on GitHub
sphinx_ext_helper module pyquickhelper.sphinxext.sphinx_ext_helper Few helpers for Sphinx. source on GitHub
sphinx_faqref_extension module pyquickhelper.sphinxext.sphinx_faqref_extension Defines a sphinx extension to keep track of FAQ. source on GitHub
sphinx_githublink_extension module pyquickhelper.sphinxext.sphinx_githublink_extension Defines a sphinx extension to display a link on github. source on GitHub
sphinx_gitlog_extension module pyquickhelper.sphinxext.sphinx_gitlog_extension Defines a sphinx extension to display gitlog text. source on GitHub
sphinx_helper module pyquickhelper.helpgen.sphinx_helper Various helpers for Sphinx. source on GitHub
sphinx_image_extension module pyquickhelper.sphinxext.sphinx_image_extension Defines a sphinx extension to add button to share a page source on GitHub
sphinx_latex_builder module pyquickhelper.sphinxext.sphinx_latex_builder Overwrites latex writer as Sphinx’s version is bugged in version 1.8.0. .. versionadded:: 1.8 source on GitHub
sphinx_main module pyquickhelper.helpgen.sphinx_main Contains the main function to generate the documentation for a module designed the same way as this one, generate_help_sphinx(). source on GitHub
sphinx_main_helper module pyquickhelper.helpgen.sphinx_main_helper Contains helpers for the main function generate_help_sphinx(). source on GitHub
sphinx_main_missing_html_files module pyquickhelper.helpgen.sphinx_main_missing_html_files function around missing file for the documentation source on GitHub
sphinx_main_verification module pyquickhelper.helpgen.sphinx_main_verification Function to verify the files produced by Sphinx source on GitHub
sphinx_mathdef_extension module pyquickhelper.sphinxext.sphinx_mathdef_extension Defines a sphinx extension to give a title to a mathematical definition, theorem… Inspired from math.py. source on GitHub
sphinx_md_builder module pyquickhelper.sphinxext.sphinx_md_builder Defines a sphinx extension to output the documentation in Markdown or MD. It is inspired from restbuilder. I replicate its license here: :: Copyright (c) 2012-2013 by Freek Dijkstra <software@macfreek.nl>. Some rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .. versionadded:: 1.8 source on GitHub
sphinx_nbref_extension module pyquickhelper.sphinxext.sphinx_nbref_extension Defines a sphinx extension to keep track of nb. source on GitHub
sphinx_postcontents_extension module pyquickhelper.sphinxext.sphinx_postcontents_extension Defines a sphinx extension which proposes a new version of .. contents:: which takes into account titles dynamically added. source on GitHub
sphinx_quote_extension module pyquickhelper.sphinxext.sphinx_quote_extension Defines a sphinx extension for a quote. source on GitHub
sphinx_rst_builder module pyquickhelper.sphinxext.sphinx_rst_builder Defines a sphinx extension to output the documentation in RST. It is inspired from restbuilder. I replicate its license here: :: Copyright (c) 2012-2013 by Freek Dijkstra <software@macfreek.nl>. Some rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. source on GitHub
sphinx_runpython_extension module pyquickhelper.sphinxext.sphinx_runpython_extension Defines runpython directives. See Tutorial: Writing a simple extension source on GitHub
sphinx_sharenet_extension module pyquickhelper.sphinxext.sphinx_sharenet_extension Defines a sphinx extension to add button to share a page source on GitHub
sphinx_template_extension module pyquickhelper.sphinxext.sphinx_template_extension Defines a sphinx extension tpl, a role which use templating. source on GitHub
sphinx_tocdelay_extension module pyquickhelper.sphinxext.sphinx_tocdelay_extension Defines a sphinx extension which proposes a new version of .. toctree:: which takes into account titles dynamically added. source on GitHub
sphinx_toctree_extension module pyquickhelper.sphinxext.sphinx_toctree_extension Overwrites toctree directive to get catch exceptions when a document is processed inline. source on GitHub
sphinx_todoext_extension module pyquickhelper.sphinxext.sphinx_todoext_extension Defines a sphinx extension to give a title to a todo, inspired from todo.py. source on GitHub
sphinx_video_extension module pyquickhelper.sphinxext.sphinx_video_extension Defines a sphinx extension to add button to share a page source on GitHub
sphinx_youtube_extension module pyquickhelper.sphinxext.sphinx_youtube_extension Inspired from sphinxcontrib.youtube (not maintained anymore). source on GitHub
sphinxext_helper module pyquickhelper.sphinxext.sphinxext_helper Helpers for sphinx extensions. source on GitHub
sphinxm_convert_doc_sphinx_helper module pyquickhelper.helpgen.sphinxm_convert_doc_sphinx_helper Helpers to convert docstring to various format. source on GitHub
sphinxm_custom_app module pyquickhelper.helpgen.sphinxm_custom_app Inspired from module sphinx-testing source on GitHub
sphinxm_mock_app module pyquickhelper.helpgen.sphinxm_mock_app Helpers to convert docstring to various format. source on GitHub
stat_helper module pyquickhelper.helpgen.stat_helper Functions about checking, statistics on files used in the documentation. source on GitHub
style_css_template module pyquickhelper.helpgen.style_css_template Custom style for the documentation. source on GitHub
svg_helper module pyquickhelper.imghelper.svg_helper Helpers around images and SVG. .. versionadded:: 1.7 source on GitHub
synchelper module pyquickhelper.filehelper.synchelper Series of functions related to folder, explore, synchronize, remove (recursively). source on GitHub
tblformat module pyquickhelper.pandashelper.tblformat To format a pandas dataframe source on GitHub
tblfunction module pyquickhelper.pandashelper.tblfunction Various function to deal with pandas tables source on GitHub
templating module pyquickhelper.texthelper.templating Templating functions source on GitHub
texts_language module pyquickhelper.texthelper.texts_language Title, text depending on language source on GitHub
tkinter_helper module pyquickhelper.pycode.tkinter_helper Helpers for tkinter source on GitHub
trace_execution module pyquickhelper.pycode.trace_execution Various function to help investigate an error. source on GitHub
transfer_api module pyquickhelper.filehelper.transfer_api API to move files source on GitHub
transfer_api_file module pyquickhelper.filehelper.transfer_api_file API to move files using FTP source on GitHub
transfer_api_ftp module pyquickhelper.filehelper.transfer_api_ftp API to move files using FTP source on GitHub
unittest_notebook module pyquickhelper.ipythonhelper.unittest_notebook Functions to test a notebook. source on GitHub
unittestclass module pyquickhelper.pycode.unittestclass Overwrites unit test class with additional testing functions. source on GitHub
url_helper module pyquickhelper.loghelper.url_helper Helpers for Internet source on GitHub
utils_pywin32 module pyquickhelper.helpgen.utils_pywin32 Functions to help using pywin32 source on GitHub
utils_sphinx_config module pyquickhelper.helpgen.utils_sphinx_config Check various settings. source on GitHub
utils_sphinx_doc module pyquickhelper.helpgen.utils_sphinx_doc various helpers to produce a Sphinx documentation source on GitHub
utils_sphinx_doc_helpers module pyquickhelper.helpgen.utils_sphinx_doc_helpers various variables and classes used to produce a Sphinx documentation source on GitHub
utils_tests module pyquickhelper.pycode.utils_tests This extension contains various functionalities to help unittesting. source on GitHub
utils_tests_helper module pyquickhelper.pycode.utils_tests_helper This extension contains various functionalities to help unittesting. source on GitHub
utils_tests_private module pyquickhelper.pycode.utils_tests_private This extension contains various functionalities to help unittesting. source on GitHub
utils_tests_stringio module pyquickhelper.pycode.utils_tests_stringio A io.StringIO which also outputs its content for a file. source on GitHub
venv_helper module pyquickhelper.pycode.venv_helper Helpers for virtualenv source on GitHub
version_helper module pyquickhelper.texthelper.version_helper Helpers about versionning. .. versionadded:: 1.8 source on GitHub
visual_sync module pyquickhelper.filehelper.visual_sync Use jsdifflib to visualize the differences between two files. source on GitHub
widgets module pyquickhelper.ipythonhelper.widgets To add interactive widgets in a notebook and connect it to Python function, Source: https://github.com/jakevdp/ipywidgets, the module was modified for Python 3 See notebook Having a form in a notebook. Copyright (c) 2013, Jake Vanderplas All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the {organization} nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. source on GitHub
windows_scripts module pyquickhelper.pycode.windows_scripts Batch file use to automate some of the tasks (setup, unit tests, help, pypi). source on GitHub
winzipfile module pyquickhelper.filehelper.winzipfile Fix a bug: see https://bugs.python.org/issue6839. source on GitHub
yaml_helper module pyquickhelper.jenkinshelper.yaml_helper Parse a file .yml and convert it into a set of actions. source on GitHub
yaml_helper_yaml module pyquickhelper.jenkinshelper.yaml_helper_yaml Puts everything related to package yaml in a separate files. source on GitHub