From bc2fdadefc0981f483f49e9ca93a6cd575c86d40 Mon Sep 17 00:00:00 2001 From: David Brochart Date: Thu, 19 Oct 2023 09:26:30 +0200 Subject: [PATCH] Update README --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8d6d491..7ad5083 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # xeus-qt-python -[![CI](https://github.com/DerThorsten/xeus-qt-python/actions/workflows/main.yml/badge.svg)](https://github.com/DerThorsten/xeus-qt-python/actions/workflows/main.yml) +[![Build Status](https://github.com/jupyter-xeus/xeus-qt-python/workflows/CI/badge.svg)](https://github.com/jupyter-xeus/xeus-qt-python/actions) You will need to compile [xeus-qt](https://github.com/jupyter-xeus/xeus-qt) and [xeus-qt-python](https://github.com/jupyter-xeus/xeus-qt-python) (this repository) from source. First clone these two repositories under `path/to/xeus-qt` and `path/to/xeus-qt-python`, respectively (or whatever place you'd like). @@ -25,9 +25,12 @@ python kernel_widget.py ``` This launches JupyterLab in a Qt application. If you look at running kernels in the left tab, you will see a kernel named `qt-python`. -Right-click on it and choose "New Console for Kernel". Now go to the file browser and double-click on the `my_notebook.ipynb` notebook. -In the "Select Kernel" menu, under "Use Kernel from Other Session" at the bottom, select "Console 1". +Right-click on it and choose "New Console for Kernel". This console won't be used, it is just a workaround to create a session with this kernel, so that we can then open a notebook using this session (this has to be improved in JupyterLab). + +Now go to the file browser and double-click on the `my_notebook.ipynb` notebook. +In the "Select Kernel" menu, under "Use Kernel from Other Session" at the bottom, select "Console 1" (or whatever number, this is the console we previously created). Now execute all the cells. The last one should display a button with the name "black magic" at the bottom of the Qt application. If you click on it, it should display "hello from here" inside the last cell. + That's it, you've just connected your custom Qt application to Jupyter! You added a button to your Qt application from a Jupyter notebook, which when clicked on, prints a message to a notebook cell output.