Skip to main content

A Qt for Python extension for Voila

Project description

QtVoila

A Qt for Python extension for Voila!

PyPI version

Introduction

This is a Qt for Python (Pyside2) widget encapsulating a Voila application. It's a convenient way of embedding the awesomeness of Voila in your Qt applications.

Installation

$ pip install qtvoila

Usage

QtVoila should be imported and used as a PySide2 widget, anywhere inside your GUI application. Although it can be initialized with default parameters, you are able to define the parent (the PySide2 application), the temporary directory where any created notebooks will be temporarily stored, the path to an existing external notebook and the boolean option to either strip code sources on Voila rendering or not:

from qtvoila import QtVoila

voila_widget = QtVoila(
    parent=None,
    temp_dir=None,
    external_notebook=None,
    strip_sources=True
)

If creating a notebook programmatically, new cells can be added with the method add_notebook_cell(). This method accepts three arguments: code_imports is a dictionary of modules to be imported, code is the string containing the cell's code or markdown text and cell_type defines if the cell is of type code or markdown. Examples:

# Mardown cell
mtext = "#This is my title\n"
mtext += "Here goes some text. Check out this graphic:"
voila_widget.add_notebook_cell(code=mtext, cell_type='markdown')

# Code cell
imports = {
  'matplotlib': ['pyplot'],
  'numpy': [],
}
code = "%matplotlib inline\n"
code += "pyplot.plot(numpy.random.rand(10))"
voila_widget.add_notebook_cell(code_imports=imports, code=code, cell_type='code')

To run the Voila process and render the result on widget:

voila_widget.run_voila()

To clear widget and stop the background Voila process:

voila_widget.close_renderer()

Examples

Here you can find some examples on how to use QtVoila in your PySide2 application. For example, creating notebooks from user's input and rendering them:

To have your GUI importing existing notebooks and rendering them:

Project details


Download files

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

Files for qtvoila, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size qtvoila-1.0.0-py3-none-any.whl (5.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size qtvoila-1.0.0.tar.gz (5.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page