Rendering buku catatan Jupyter langsung dengan widget interaktif.
Voilà mengubah notebook Jupyter menjadi aplikasi web mandiri.
Berbeda dengan notebook yang dikonversi ke HTML pada umumnya, setiap pengguna yang terhubung ke aplikasi Voilà tornado mendapatkan kernel Jupyter khusus yang dapat menjalankan callback ke perubahan di widget interaktif Jupyter.
Secara default, Voilà melarang eksekusi permintaan dari front-end, sehingga mencegah eksekusi kode arbitrer.
Secara default, Voila berjalan dengan opsi strip_sources
, yang menghapus sel masukan dari buku catatan yang dirender.
Voilà dapat diinstal dengan manajer paket mamba (atau conda) dari conda-forge
mamba install -c conda-forge voila
atau dari PyPI
pip install voila
Voilà menyediakan ekstensi JupyterLab yang menampilkan pratinjau Voilà Notebook Anda di panel samping.
Dimulai dengan JupyterLab 3.0, ekstensi diinstal secara otomatis setelah instalasi voila
dengan pip install voila
.
Jika Anda ingin memasang ekstensi dari sumber, jalankan perintah berikut.
jupyter labextension install @voila-dashboards/jupyterlab-preview
Untuk merender buku catatan contoh bqplot
sebagai aplikasi mandiri, jalankan voila bqplot.ipynb
. Untuk menyajikan direktori notebook jupyter, jalankan voila
tanpa argumen.
Misalnya, untuk merender contoh buku catatan bqplot.ipynb
dari repositori ini dengan Voilà, Anda dapat memperbarui lingkungan Anda saat ini terlebih dahulu dengan persyaratan buku catatan ini (dalam hal ini di lingkungan conda dan merender buku catatan dengan
mamba env update -f .binder/environment.yml cd notebooks/ voila bqplot.ipynb
Untuk opsi baris perintah lainnya (misalnya, untuk menentukan nomor port alternatif), jalankan voila --help
.
notebook
atau jupyter_server
Voilà juga dapat digunakan sebagai ekstensi server Jupyter, baik dengan server notebook atau dengan jupyter_server.
Untuk menginstal ekstensi server Jupyter, jalankan
jupyter serverextension enable voila jupyter server extension enable voila
Saat menjalankan server Jupyter, aplikasi Voilà dapat diakses dari url dasar yang diberi akhiran voila
.
Untuk mulai menggunakan Voila, lihat dokumentasi lengkapnya:
https://voila.readthedocs.io/
Dua contoh berikut menunjukkan bagaimana notebook Jupyter mandiri dapat diubah menjadi aplikasi terpisah, dari integrasi baris perintah.
Sumber notebook Jupyter dapat ditampilkan di aplikasi Voilà jika opsi strip_sources
disetel ke False
.
Voilà dibangun berdasarkan format dan protokol standar Jupyter, dan tidak bergantung pada bahasa pemrograman notebook. Dalam contoh ini, kami menyajikan contoh aplikasi Voilà yang didukung oleh kernel C++ Jupyter xeus-cling, dan proyek xleaflet.
Galeri Voilà adalah kumpulan dasbor langsung dan aplikasi yang dibangun dengan widget Voilà dan Jupyter.
Sebagian besar contoh mengandalkan pustaka widget seperti ipywidgets, ipyleaflet, ipyvolume, bqplot, dan ipympl, dan menunjukkan cara membangun aplikasi web yang kompleks sepenuhnya berdasarkan notebook.
Contoh baru dapat ditambahkan ke galeri dengan mengikuti langkah-langkah yang tercantum di repositori voila-gallery/gallery.
Lihat CONTRIBUTING.md untuk mengetahui cara berkontribusi dan menyiapkan lingkungan pengembangan.
Voila bergantung pada nbconvert dan jupyter_server.
Kami menggunakan model hak cipta bersama yang memungkinkan semua kontributor mempertahankan hak cipta atas kontribusi mereka.
Perangkat lunak ini dilisensikan di bawah lisensi BSD-3-Clause. Lihat file LISENSI untuk detailnya.