voila

การแสดงสมุดบันทึก Jupyter แบบสดพร้อมวิดเจ็ตแบบโต้ตอบ

การแนะนำ

Voila เปลี่ยนสมุดบันทึก Jupyter ให้เป็นเว็บแอปพลิเคชันแบบสแตนด์อโลน

ต่างจากโน้ตบุ๊กที่แปลง HTML ตามปกติ ผู้ใช้แต่ละรายที่เชื่อมต่อกับแอปพลิเคชัน Voilà tornado จะได้รับเคอร์เนล Jupyter เฉพาะ ซึ่งสามารถดำเนินการเรียกกลับไปยังการเปลี่ยนแปลงในวิดเจ็ตแบบโต้ตอบของ Jupyter

• ตามค่าเริ่มต้น Voilà ไม่อนุญาตให้ดำเนินการคำขอจากส่วนหน้า ป้องกันการเรียกใช้โค้ดที่กำหนดเอง

• ตามค่าเริ่มต้น Voila จะทำงานโดยใช้ตัวเลือก strip_sources ซึ่งจะตัดเซลล์อินพุตออกจากสมุดบันทึกที่แสดงผล

การติดตั้ง

สามารถติดตั้งVoilàได้ด้วยตัวจัดการแพ็คเกจ mamba (หรือ conda) จาก conda-forge

mamba install -c conda-forge voila

หรือจาก PyPI

pip install voila

ส่วนขยายการแสดงตัวอย่าง JupyterLab

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

Voila ยังสามารถใช้เป็นส่วนขยายเซิร์ฟเวอร์ Jupyter ได้ทั้งกับเซิร์ฟเวอร์โน้ตบุ๊กหรือกับ jupyter_server

หากต้องการติดตั้งส่วนขยายเซิร์ฟเวอร์ Jupyter ให้รัน

jupyter serverextension enable voila
jupyter server extension enable voila

เมื่อรันเซิร์ฟเวอร์ Jupyter แอป Voila จะสามารถเข้าถึงได้จาก URL ฐานที่ต่อท้ายด้วย voila

เอกสารประกอบ

หากต้องการเริ่มต้นใช้งานVoilà โปรดดูเอกสารฉบับเต็ม:

https://voila.readthedocs.io/

ตัวอย่าง

สองตัวอย่างต่อไปนี้แสดงให้เห็นว่าโน้ตบุ๊ก Jupyter แบบสแตนด์อโลนสามารถเปลี่ยนเป็นแอปแยกต่างหากจากการผสานรวมบรรทัดคำสั่งได้อย่างไร

การเรนเดอร์สมุดบันทึกรวมถึงวิดเจ็ตแบบโต้ตอบและการเรนเดอร์ประเภท mime ที่หลากหลาย

การเรนเดอร์โน้ตบุ๊กโดยใช้ไลบรารีวิดเจ็ตแบบกำหนดเอง (bqplot)

กำลังแสดงซอร์สโค้ดสำหรับสมุดบันทึกVoilà

แหล่งที่มาของสมุดบันทึก Jupyter สามารถแสดงในแอปVoilà หากตั้งค่าตัวเลือก strip_sources เป็น False

Voila แดชบอร์ดพร้อมเคอร์เนลภาษาอื่น**

Voila สร้างขึ้นจากรูปแบบและโปรโตคอลมาตรฐานของ Jupyter และไม่เชื่อเรื่องภาษาการเขียนโปรแกรมของโน้ตบุ๊ก ในตัวอย่างนี้ เรานำเสนอตัวอย่างของแอปพลิเคชันVoilàที่ขับเคลื่อนโดยเคอร์เนล C++ Jupyter xeus-cling และโปรเจ็กต์ xleaflet

แกลลอรี่ Voila

Voilà Gallery คือชุดแดชบอร์ดและแอปพลิเคชันสดที่สร้างขึ้นด้วยวิดเจ็ต Voilà และ Jupyter

ตัวอย่างส่วนใหญ่อาศัยไลบรารีวิดเจ็ต เช่น ipywidgets, ipyleaflet, ipyvolume, bqplot และ ipympl และแสดงวิธีสร้างแอปพลิเคชันเว็บที่ซับซ้อนโดยใช้โน้ตบุ๊กทั้งหมด

คุณสามารถเพิ่มตัวอย่างใหม่ลงในแกลเลอรีได้โดยทำตามขั้นตอนที่ระบุไว้ในพื้นที่เก็บข้อมูล voila-gallery/gallery

การพัฒนา

ดู CONTRIBUTING.md เพื่อทราบวิธีมีส่วนร่วมและตั้งค่าสภาพแวดล้อมการพัฒนา

โครงการที่เกี่ยวข้อง

Voila ขึ้นอยู่กับ nbconvert และ jupyter_server

ใบอนุญาต

เราใช้รูปแบบลิขสิทธิ์ที่ใช้ร่วมกันซึ่งช่วยให้ผู้มีส่วนร่วมทุกคนสามารถรักษาลิขสิทธิ์ในผลงานของพวกเขาได้

ซอฟต์แวร์นี้ได้รับอนุญาตภายใต้ใบอนุญาต BSD-3-Clause ดูไฟล์ใบอนุญาตสำหรับรายละเอียด