Skip to main content

Prerequisites

Jupyter Notebook and Kqlmagic

Installation

To install using pip:

pip install kqlmagic_kernel

Add --user to install in the user-level environment instead of the system environment.

To install using conda:

conda config --add channels conda-forge
conda install kqlmagic_kernel
conda install texinfo # For the inline documentation (shift-tab) to appear.
python -m kqlmagic_kernel.install

Kqlmagic Jupyter kernelspec is automatically installed as part of the python package. This location can be found using jupyter kernelspec list. If the default location is not desired, remove the directory for the kqlmagic kernel, and install using python -m kqlmagic_kernel install. See python -m kqlmagic_kernel install --help for available options.

Usage

To use the kernel, run one of:

jupyter notebook
# In the notebook interface, select Kqlmagic from the 'New' menu
jupyter qtconsole --kernel kqlmagic
jupyter console --kernel kqlmagic

This kernel is based on ipykernel, which means it features a standard set of magics (such as %%html). For a full list of magics, run %lsmagic in a cell.

A sample notebook is available online.

Configuration

The kernel can be configured by adding an kqlmagic_kernel_config.py file to the jupyter config path.

The path to the Kqlmagic kernel JSON file can also be specified by creating an KQLMAGIC_KERNEL_JSON environment variable.

Troubleshooting

Kernel Times Out While Starting

If the kernel does not start, run the following command from a terminal:

python -m kqlmagic_kernel.check

This can help diagnose problems with setting up integration with Octave. If in doubt, create an issue with the output of that command.

Kernel is Not Listed

If the kernel is not listed as an available kernel, first try the following command:

python -m kqlmagic_kernel install --user

If the kernel is still not listed, verify that the following point to the same version of python:

which python  # use "where" if using cmd.exe
which jupyter

For details of how this works, see the Jupyter docs on wrapper kernels

Release files for kqlmagic-kernel 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kqlmagic-kernel 0.1.0
File Size Uploaded
kqlmagic_kernel-0.1.0.tar.gz 10.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for kqlmagic-kernel 0.1.0
File Interpreter ABI Platform
kqlmagic_kernel-0.1.0-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 23.6 kB

Release files / kqlmagic_kernel-0.1.0.tar.gz

Download URL kqlmagic_kernel-0.1.0.tar.gz
Size 10.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0cd6033b52110755d28bf55e1bfef9c2ad47335bb85d1759a9e0ffe40dcd299b
BLAKE2b-256 checksum
How to use checksums
788833b10853c47cb767d668e4eca0449761ceef81c9cf099bcf6c924292711b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/59.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.10

Release files / kqlmagic_kernel-0.1.0-py2.py3-none-any.whl

Download URL kqlmagic_kernel-0.1.0-py2.py3-none-any.whl
Size 12.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
a7b54a9dee31e9c65666d902d7f05bc6558f690c2f62538289883623a37c77c7
BLAKE2b-256 checksum
How to use checksums
eefcbaebb0303a541a4fca3b900a486fae4de5f77e87fec69a23dc0af8337300
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/59.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.10

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page