Representación de cuadernos Jupyter en vivo con widgets interactivos.
Voilà convierte los portátiles Jupyter en aplicaciones web independientes.
A diferencia de los cuadernos habituales convertidos en HTML, cada usuario que se conecta a la aplicación Voilà tornado obtiene un kernel de Jupyter dedicado que puede ejecutar devoluciones de llamada a los cambios en los widgets interactivos de Jupyter.
De forma predeterminada, Voilà no permite ejecutar solicitudes desde el front-end, impidiendo la ejecución de código arbitrario.
De forma predeterminada, Voilà se ejecuta con la opción strip_sources
, que elimina las celdas de entrada del cuaderno renderizado.
Voilà se puede instalar con el administrador de paquetes mamba (o conda) de conda-forge
mamba install -c conda-forge voila
o desde PyPI
pip install voila
Voilà proporciona una extensión de JupyterLab que muestra una vista previa de Voilà de su Notebook en un panel lateral.
A partir de JupyterLab 3.0, la extensión se instala automáticamente después de instalar voila
con pip install voila
.
Si desea instalar la extensión desde la fuente, ejecute el siguiente comando.
jupyter labextension install @voila-dashboards/jupyterlab-preview
Para representar el cuaderno de ejemplo bqplot
como una aplicación independiente, ejecute voila bqplot.ipynb
. Para servir un directorio de cuadernos jupyter, ejecute voila
sin argumentos.
Por ejemplo, para renderizar el cuaderno de ejemplo bqplot.ipynb
desde este repositorio con Voilà, primero puede actualizar su entorno actual con los requisitos de este cuaderno (en este caso en un entorno conda y renderizar el cuaderno con
mamba env update -f .binder/environment.yml cd notebooks/ voila bqplot.ipynb
Para obtener más opciones de línea de comando (por ejemplo, para especificar un número de puerto alternativo), ejecute voila --help
.
notebook
o jupyter_server
Voilà también se puede utilizar como extensión del servidor Jupyter, tanto con el servidor portátil como con jupyter_server.
Para instalar la extensión del servidor Jupyter, ejecute
jupyter serverextension enable voila jupyter server extension enable voila
Cuando se ejecuta el servidor Jupyter, se puede acceder a la aplicación Voilà desde la URL base con el sufijo voila
.
Para comenzar a usar Voilà, consulte la documentación completa:
https://voila.readthedocs.io/
Los dos ejemplos siguientes muestran cómo un cuaderno Jupyter independiente se puede convertir en una aplicación independiente, desde la integración de la línea de comandos.
Las fuentes del cuaderno Jupyter se pueden mostrar en una aplicación Voilà si la opción strip_sources
está configurada en False
.
Voilà se basa en los formatos y protocolos estándar de Jupyter y es independiente del lenguaje de programación del portátil. En este ejemplo, presentamos un ejemplo de una aplicación Voilà impulsada por el kernel xeus-cling de C++ Jupyter y el proyecto xleaflet.
La Galería Voilà es una colección de paneles en vivo y aplicaciones creadas con widgets de Voilà y Jupyter.
La mayoría de los ejemplos se basan en bibliotecas de widgets como ipywidgets, ipyleaflet, ipyvolume, bqplot e ipympl, y muestran cómo crear aplicaciones web complejas basadas completamente en portátiles.
Se pueden agregar nuevos ejemplos a la galería siguiendo los pasos enumerados en el repositorio voila-gallery/gallery.
Consulte CONTRIBUTING.md para saber cómo contribuir y configurar un entorno de desarrollo.
Voilà depende de nbconvert y jupyter_server.
Utilizamos un modelo de derechos de autor compartido que permite a todos los contribuyentes mantener los derechos de autor de sus contribuciones.
Este software tiene la licencia BSD-3-Clause. Consulte el archivo de LICENCIA para obtener más detalles.