Tools for using Civis Platform with Jupyter notebooks
Project description
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.
Magic Commands
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.
SQL Queries
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;
Project details
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
Close
Hashes for civis_jupyter_extensions-1.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7731dddf8706cb26dc9c0bcb90279f3bc87aa3a0fdf8ac66b4c95eefc77ae00 |
|
MD5 | 04933d1bb2306dfb23a9fbb71b2c308e |
|
BLAKE2b-256 | ff7df5b414c79e736139c9de71bf1d8494c4737aacd91c6e3612dfd5ab0d8d32 |
Close
Hashes for civis_jupyter_extensions-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d157c1d36c61a3e834b5218e86d3dbbc617dd461531427b02761dc3b535b285 |
|
MD5 | 97b3d7db590f59749bdcb221aedcf361 |
|
BLAKE2b-256 | 595357c20df029cf887d3ad867b19d70298de30d967ed3d801c0c556f583a1fc |