Tools for using the Civis Platform with Jupyter notebooks.
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:
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.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size civis-jupyter-extensions-1.0.0.tar.gz (5.3 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for civis-jupyter-extensions-1.0.0.tar.gz