Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

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

Project Description

README

Links:

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

1.5.???? (2017-??-??)

Bugfix

  • 46: update to Sphinx 1.6
  • 54: fix searchbox for sphinx_rtd_theme
  • 69: overwrites toctree to catch exception and process rst inline
  • 71: skip old notebook execution when computing the coverage

Features

  • 56: support function for role epkg
  • 36: add support for sphinx-gallery
  • 53: handle history, converts the file into something usable by module releases
  • 52: add coverage for notebooks
  • 61: add a build on circleci, builds the documentation, populates the artifacts section
  • 63: add file_detail in get_repo_log
  • 60: add notebook coverage as a separate page
  • 34: applies pep8 on the code being rendered on the documentation
  • 65: add function to clean readme.rst before sending it to pypi
  • 67: add toctree delayed which gets filled after the dynamic content is created, use it for blogs
  • 77: add class ExtUnitCase with extensive test function
  • 78: get_temp_folder change other default directory
  • 81: add youtube sphinx extension
Release History

Release History

This version
History Node

1.5.2259

History Node

1.5.2246

History Node

1.5.2234

History Node

1.5.2224

History Node

1.5.2220

History Node

1.5.2215

History Node

1.5.2212

History Node

1.5.2211

History Node

1.5.2208

History Node

1.5.2197

History Node

1.5.2186

History Node

1.5.2183

History Node

1.5.2175

History Node

1.5.2170

History Node

1.5.2156

History Node

1.5.2133

History Node

1.5.2127

History Node

1.5.2126

History Node

1.5.2122

History Node

1.5.2064

History Node

1.5.2055

History Node

1.5.2025

History Node

1.5.2024

History Node

1.5.2021

History Node

1.5.2015

History Node

1.5.2007

History Node

1.5.1937

History Node

1.5.1920

History Node

1.5.1916

History Node

1.5.1909

History Node

1.5.1907

History Node

1.5.1895

History Node

1.5.1888

History Node

1.5.1886

History Node

1.5.1885

History Node

1.5.1865

History Node

1.5.1857

History Node

1.5.1852

History Node

1.5.1838

History Node

1.5.1836

History Node

1.5.1835

History Node

1.5.1833

History Node

1.5.1810

History Node

1.5.1796

History Node

1.5.1793

History Node

1.5.1785

History Node

1.5.1778

History Node

1.5.1749

History Node

1.5.1713

History Node

1.5.1695

History Node

1.5.1670

History Node

1.5.1573

History Node

1.4.1533

History Node

1.3.1110

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
pyquickhelper-1.5.2259-py3-none-any.whl (519.1 kB) Copy SHA256 Checksum SHA256 3.6 Wheel Nov 12, 2017
pyquickhelper-1.5.2259.tar.gz (3.0 MB) Copy SHA256 Checksum SHA256 Source Nov 12, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting