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;

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

Source distribution for civis-jupyter-extensions 1.2.0
File	Size	Uploaded
civis_jupyter_extensions-1.2.0.tar.gz	5.9 kB	Jun 10, 2024	Details

Table of built distributions (wheels) for civis-jupyter-extensions 1.2.0
File	Interpreter	ABI	Platform	Reset
civis_jupyter_extensions-1.2.0-py3-none-any.whl 5.6 kB Jun 10, 2024	Python 3	none	any	Details

Total release size: 11.4 kB

Download URL	civis_jupyter_extensions-1.2.0.tar.gz
Size	5.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`f7731dddf8706cb26dc9c0bcb90279f3bc87aa3a0fdf8ac66b4c95eefc77ae00`
BLAKE2b-256 checksum How to use checksums	`ff7df5b414c79e736139c9de71bf1d8494c4737aacd91c6e3612dfd5ab0d8d32`
Upload date	Jun 10, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.12.2`

Download URL	civis_jupyter_extensions-1.2.0-py3-none-any.whl
Size	5.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`9d157c1d36c61a3e834b5218e86d3dbbc617dd461531427b02761dc3b535b285`
BLAKE2b-256 checksum How to use checksums	`595357c20df029cf887d3ad867b19d70298de30d967ed3d801c0c556f583a1fc`
Upload date	Jun 10, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.12.2`