civis-jupyter-extensions

Tools for using the Civis Platform with Jupyter notebooks

Installation and Setup

Run the following commands in a shell:

pip install civis-jupyter-extensions
jupyter nbextension install --py civis_jupyter_ext
jupyter nbextension enable --py civis_jupyter_ext

In order to use the extensions, make sure to have your Civis Platform API key in your local environment as CIVIS_API_KEY.

To load the magic commands, use the following in ipython or a Jupyter notebook:

%load_ext civis_jupyter_ext

You can also autoload the magic commands every time a notebook is opened by adding:

c.InteractiveShellApp.extensions = ['civis_jupyter_ext']

to your ~/.ipython/profile_default/ipython_config.py.

To get a table preview, use the cell magic like this:

%%civisquery my-database
select * from dummy.table limit 10;

To return a DataFrame for further processing, use the line magic like this:

df = %civisquery my-database; select * from dummy.table;

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Uploaded Jun 10, 2024 Source

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

Uploaded Jun 10, 2024 Python 3

Details for the file civis_jupyter_extensions-1.2.0.tar.gz.

Hashes for civis_jupyter_extensions-1.2.0.tar.gz
Algorithm	Hash digest
SHA256	`f7731dddf8706cb26dc9c0bcb90279f3bc87aa3a0fdf8ac66b4c95eefc77ae00`
MD5	`04933d1bb2306dfb23a9fbb71b2c308e`
BLAKE2b-256	`ff7df5b414c79e736139c9de71bf1d8494c4737aacd91c6e3612dfd5ab0d8d32`

Details for the file civis_jupyter_extensions-1.2.0-py3-none-any.whl.