Skip to content

Latest commit

 

History

History
102 lines (69 loc) · 4.69 KB

README.md

File metadata and controls

102 lines (69 loc) · 4.69 KB
Raw

xeus-sqlite

Azure Pipelines Documentation Status Binder

xeus-sqlite is a Jupyter kernel for SQL based on the native implementation of the Jupyter protocol xeus.

xeus-sqlite now supports vega visualizations thanks to xvega.

Usage

Launch the Jupyter notebook with jupyter notebook or Jupyter lab with jupyter lab and launch a new SQL notebook by selecting the xsqlite kernel.

Installation

xeus-sqlite has been packaged for the mamba (or conda) package manager on the Linux and OS X platforms. At the moment, we are not providing packages for the Windows platform.

To ensure that the installation works, it is preferable to install xeus-sqlite in a fresh environment.

To ensure that the installation works, it is preferable to install xeus in a fresh environment. It is also needed to use a miniforge or miniconda installation because with the full anaconda you may have a conflict.

The safest usage is to create an environment named xeus-sqlite

mamba create -n xeus-sqlite
source activate xeus-sqlite

Installing from conda-forge

To install xeus-sqlite with the mamba (or conda) package manager

mamba install xeus-sqlite jupyterlab -c conda-forge

Installing from source

To install the xeus-sqlite dependencies

mamba install cmake nlohmann_json xtl cppzmq xeus sqlite sqlitecpp cpp-tabulate=1.5 xvega xproperty xtl cppzmq xproperty jupyterlab -c conda-forge

Then you can compile the sources

mkdir build
cd build
cmake -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX ..
make
make install

Documentation

https://xeus-sqlite.readthedocs.io/en/latest/

Build docs

mamba install sphinx breathe doxygen sphinx_rtd_theme

Dependencies

xeus-sqlite depends on

xeus-sqlite xeus-zmq SQLite SQLiteCPP tabulate nlohmann_json xvega xvega-bindings
main >=1.1.1, <2.0.0 >=3.30.1, <4 >=3.0.0, <4 >=1.5.0 >=3.0.0 >= 0.0.10 >= 0.0.3
0.6.0 >=1.0.2, <2.0.0 >=3.30.1, <4 >=3.0.0, <4 >=1.3.0,<1.5 >=3.0.0 >= 0.0.10 >= 0.0.3

Prior to version 0.6, xeus-sqlite was depending on xeus instead of xeus-zmq:

xeus-sqlite xeus SQLite SQLiteCPP tabulate nlohmann_json xvega xvega-bindings
0.5.2 >=2.4.0, <3.0.0 >=3.30.1, <4 >=3.0.0, <4 >=1.3.0,<1.5 >=3.0.0 >= 0.0.10 >= 0.0.3
0.5.1 >=2.0.0, <3.0.0 >=3.30.1, <4 >=3.0.0, <4 >=1.3.0,<1.5 >=3.0.0 >= 0.0.10 >= 0.0.3
0.3.0 >=1.0.0, <2.0.0 >=3.30.1, <4 >=3.0.0, <4 >=1.3.0,<1.5 >=3.0.0 >= 0.0.10 >= 0.0.3
0.2.0 >=0.23.9, <0.24 >=3.30.1, <4 >=3.0.0, <4 =1.2.0 >=3.0.0 >= 0.0.5 >= 0.0.3
0.1.1 >=0.24.0, <0.25 >=3.30.1, <4 >=3.0.0, <4 >=1.3.0,<1.5 >=3.0.0 >= 0.0.4 >= 0.0.3
0.1.0 >=0.23.9, <0.24 >=3.30.1, <4 >=3.0.0, <4 =1.2.0 >=3.0.0 >= 0.0.4 >= 0.0.3

Contributing

See CONTRIBUTING.md to know how to contribute and set up a development environment.

License

We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.

This software is licensed under the BSD-3-Clause license. See the LICENSE file for details.