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
Close
Hashes for civis-jupyter-extensions-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 452e09892557339d6878049729fb5b4f851a72229bffda8df1886d14b6f42400 |
|
MD5 | 86551ef4e333416c327b5bed0bee9c2d |
|
BLAKE2b-256 | 1be80271108f08f0132f28ab4bec2e9a21b60ce07439d23128ab2fc2a6416ede |