Tools for using the 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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ab2a2f7cd1c8075ff2cdde451e1daf12d54021be2c108f14989eb404174340d |
|
MD5 | 9ca771db011397015c859175469f861a |
|
BLAKE2b-256 | 5ab4f2366deabf3d48fd21e91741d5eff1616fd6ab0c0747cb74dcbf40b40070 |
Close
Hashes for civis_jupyter_extensions-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6284a8f5ca21107dc51332e0084db8ce0fc2ef99604380851604e5edd73a399b |
|
MD5 | 539cc0e31c6d4c43a6676ff03d17b4bf |
|
BLAKE2b-256 | a3679baf3bf19c10b38e5bcbc6a427caaf26c2c52acaa1ccc2dc4da8cae0a7b3 |