Рендеринг живых блокнотов Jupyter с интерактивными виджетами.
Вуаля превращает блокноты Jupyter в автономные веб-приложения.
В отличие от обычных блокнотов, конвертированных в HTML, каждый пользователь, подключающийся к приложению Voilà Tornado, получает выделенное ядро Jupyter, которое может выполнять обратные вызовы для изменений в интерактивных виджетах Jupyter.
По умолчанию Voilà запрещает запросы на выполнение из внешнего интерфейса, предотвращая выполнение произвольного кода.
По умолчанию Voilà запускается с параметром strip_sources
, который удаляет входные ячейки из отображаемого блокнота.
Вуаля можно установить с помощью менеджера пакетов mamba (или conda) из conda-forge.
mamba install -c conda-forge voila
или из PyPI
pip install voila
Voilà предоставляет расширение JupyterLab, которое отображает предварительный просмотр Voilà вашего ноутбука на боковой панели.
Начиная с JupyterLab 3.0, расширение автоматически устанавливается после установки voila
с помощью pip install voila
.
Если вы хотите установить расширение из исходного кода, выполните следующую команду.
jupyter labextension install @voila-dashboards/jupyterlab-preview
Чтобы отобразить пример записной книжки bqplot
как отдельное приложение, запустите voila bqplot.ipynb
. Чтобы обслуживать каталог записных книжек Jupyter, запустите voila
без аргументов.
Например, чтобы отобразить пример блокнота bqplot.ipynb
из этого репозитория с помощью Voilà, вы можете сначала обновить текущую среду в соответствии с требованиями этого блокнота (в данном случае в среде conda и визуализировать блокнот с помощью
mamba env update -f .binder/environment.yml cd notebooks/ voila bqplot.ipynb
Чтобы получить дополнительные параметры командной строки (например, указать альтернативный номер порта), выполните команду voila --help
.
notebook
или jupyter_server
Voilà также можно использовать в качестве расширения сервера Jupyter как с сервером ноутбука, так и с jupyter_server.
Чтобы установить расширение сервера Jupyter, запустите
jupyter serverextension enable voila jupyter server extension enable voila
При запуске сервера Jupyter приложение Voilà доступно по базовому URL-адресу с суффиксом voila
.
Чтобы начать использовать Voilà, ознакомьтесь с полной документацией:
https://voila.readthedocs.io/
Следующие два примера показывают, как автономный блокнот Jupyter можно превратить в отдельное приложение с помощью интеграции командной строки.
Исходные коды блокнота Jupyter могут отображаться в приложении Voilà, если для параметра strip_sources
установлено значение False
.
Voilà построен на стандартных форматах и протоколах Jupyter и не зависит от языка программирования ноутбука. В этом примере мы представляем пример приложения Voilà на базе ядра C++ Jupyter xeus-cling и проекта xleaflet.
Галерея Voilà — это коллекция живых панелей мониторинга и приложений, созданных с помощью виджетов Voilà и Jupyter.
Большинство примеров основаны на библиотеках виджетов, таких как ipywidgets, ipyleaflet, ipyvolume, bqplot и ipympl, и демонстрируют, как создавать сложные веб-приложения, полностью основанные на блокнотах.
Новые примеры можно добавить в галерею, выполнив действия, перечисленные в репозитории voila-gallery/gallery.
Посетите CONTRIBUTING.md, чтобы узнать, как внести свой вклад и настроить среду разработки.
Вуаля зависит от nbconvert и jupyter_server.
Мы используем модель общего авторского права, которая позволяет всем участникам сохранять авторские права на свои материалы.
Это программное обеспечение распространяется по лицензии BSD-3-Clause. Подробности смотрите в файле ЛИЦЕНЗИИ.