PyWebIO/docs/libraries_support.rst

Libraries support
======================

.. _stand_alone_app:

Build stand-alone App
----------------------
`PyInstaller <https://pyinstaller.readthedocs.io/en/stable/>`_ bundles a Python application and all its dependencies into a folder or executable. The user can run the packaged app without installing a Python interpreter or any modules.

You can use PyInstaller to packages PyWebIO application into a stand-alone executable or folder:

1. Create a pyinstaller spec (specification) file::

    pyi-makespec <options> app.py

   You need replace ``app.py`` to your PyWebIO application file name.

2. Only for PyWebIO before v1.8: Edit the spec file, change the ``datas`` parameter of ``Analysis``::

    from pywebio.utils import pyinstaller_datas

    a = Analysis(
        ...
        datas=pyinstaller_datas(),
        ...

3. Build the application by passing the spec file to the pyinstaller command::

    pyinstaller app.spec


If you want to create a one-file bundled executable, you need pass ``--onefile`` option in first step.

For more information, please visit: https://pyinstaller.readthedocs.io/en/stable/spec-files.html


.. _visualization:

Data visualization
--------------------
PyWebIO supports for data visualization with the third-party libraries.

Bokeh
^^^^^^^^^^^^^^^^^^^^^^

`Bokeh <https://github.com/bokeh/bokeh>`_ is an interactive visualization library for modern web browsers. It provides elegant, concise construction of versatile graphics, and affords high-performance interactivity over large or streaming datasets.

You can use ``bokeh.io.output_notebook(notebook_type='pywebio')`` in the PyWebIO session to setup Bokeh environment.
Then you can use ``bokeh.io.show()`` to output a boken chart::

    from bokeh.io import output_notebook
    from bokeh.io import show

    output_notebook(notebook_type='pywebio')
    fig = figure(...)
    ...
    show(fig)

See related demo on :charts_demo_host:`bokeh demo </?app=bokeh>`

In addition to creating ordinary charts, Bokeh can also build the Bokeh applications by starting the `Bokeh server <https://docs.bokeh.org/en/latest/docs/user_guide/server.html>`_. The purpose of the Bokeh server is to make it easy for Python users to create interactive web applications that can connect front-end UI events to real, running Python code.

In PyWebIO, you can also use ``bokeh.io.show()`` to display a Bokeh App. For the example, see `bokeh_app.py <https://github.com/wang0618/PyWebIO/blob/dev/demos/bokeh_app.py>`_.

.. note:: Bokeh App currently is only available in the default Tornado backend

.. image:: https://fastly.jsdelivr.net/gh/wang0618/pywebio-chart-gallery@master/assets/bokeh.png

pyecharts
^^^^^^^^^^^^^^^^^^^^^^

`pyecharts <https://github.com/pyecharts/pyecharts>`_  is a python plotting library which uses `Echarts <https://github.com/ecomfe/echarts>`_ as underlying implementation.

In PyWebIO, you can use the following code to output the pyecharts chart instance::

    # `chart` is pyecharts chart instance
    pywebio.output.put_html(chart.render_notebook())

See related demo on :charts_demo_host:`pyecharts demo </?app=pyecharts>`

.. only:: not latex

    .. image:: https://fastly.jsdelivr.net/gh/wang0618/pywebio-chart-gallery@master/assets/pyecharts.gif

plotly
^^^^^^^^^^^^^^^^^^^^^^

`plotly.py <https://github.com/plotly/plotly.py>`_ is an interactive, open-source, and browser-based graphing library for Python.

In PyWebIO, you can use the following code to output the plotly chart instance::

    # `fig` is plotly chart instance
    html = fig.to_html(include_plotlyjs="require", full_html=False)
    pywebio.output.put_html(html)

See related demo on :charts_demo_host:`plotly demo </?app=plotly>`

.. image:: https://fastly.jsdelivr.net/gh/wang0618/pywebio-chart-gallery@master/assets/plotly.png

pyg2plot
^^^^^^^^^^^^^^^^^^^^^^

`pyg2plot <https://github.com/hustcc/PyG2Plot>`_ is a python plotting library which uses `G2Plot <https://github.com/antvis/G2Plot>`_ as underlying implementation.

In PyWebIO, you can use the following code to output the pyg2plot chart instance::

    # `chart` is pyg2plot chart instance
    pywebio.output.put_html(chart.render_notebook())

See related demo on :charts_demo_host:`plotly demo </?app=pyg2plot>`

cutecharts.py
^^^^^^^^^^^^^^^^^^^^^^

`cutecharts.py <https://github.com/cutecharts/cutecharts.py>`_ is a hand drawing style charts library for Python which uses `chart.xkcd <https://github.com/timqian/chart.xkcd>`_ as underlying implementation.

In PyWebIO, you can use the following code to output the cutecharts.py chart instance::

    # `chart` is cutecharts chart instance
    pywebio.output.put_html(chart.render_notebook())

See related demo on :charts_demo_host:`cutecharts demo </?app=cutecharts>`

.. image:: https://fastly.jsdelivr.net/gh/wang0618/pywebio-chart-gallery@master/assets/cutecharts.png