JupyterNotebook Flink magics
Project description
Streaming Jupyter Integrations
Streaming Jupyter Integrations project includes a set of magics for interactively running Flink SQL
jobs in Jupyter Notebooks
In order to actually use these magics, you must install our PIP package along jupyterlab-lsp
:
python3 -m pip install jupyterlab-lsp streaming-jupyter-integrations
And then register in Jupyter with a running IPython in the first cell:
%load_ext streaming_jupyter_integrations.magics
Local development
Note: You will need NodeJS to build the extension package.
The jlpm
command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
yarn
or npm
in lieu of jlpm
below. In order to use jlpm
, you have to
have jupyterlab
installed (e.g., by brew install jupyterlab
, if you use
Homebrew as your package manager).
# Clone the repo to your local environment
# Change directory to the flink_sql_lsp_extension directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm build
The project uses pre-commit hooks to ensure code quality, mostly by linting. To use it, install pre-commit and then run
pre-commit install --install-hooks
From that moment, it will lint the files you have modified on every commit attempt.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for streaming_jupyter_integrations-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f89962f76a3a00bac07b756f50d71d2476505cd47bc6343525f4a21e515d1263 |
|
MD5 | 84573f273596f5de472dff20927447d2 |
|
BLAKE2b-256 | f3eea7eeeb33ee796e41740cdc94423bc4598094cc324b51516e4a92ab870e91 |
Hashes for streaming_jupyter_integrations-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e203b8595cde7ebfa49cf50585aede442bbfafeee2a2b6fa0cf716f1b58f797 |
|
MD5 | 4b0169ac530bbe8d811e6d5995991625 |
|
BLAKE2b-256 | 3a6972bb4e327626dc7dde40b31fb4a55b567d683103e1e916a94cbb6ea56bdf |