jupyter notebook extension to connect to graph databases
Project description
graph-notebook
Python package integrating jupyter notebooks with various graph-stores including Apache TinkerPop and RDF SPARQL.
Requirements
- Python3.6
- Jupyter Notebooks
Installation
# install the package
pip install graph-notebook
# install and enable the visualization widget
jupyter nbextension install --py --sys-prefix graph_notebook.widgets
jupyter nbextension enable --py --sys-prefix graph_notebook.widgets
# copy static html resources
python -m graph_notebook.static_resources.install
python -m graph_notebook.nbextensions.install
# copy premade starter notebooks
python -m graph_notebook.notebooks.install --destination /notebook/destination/dir
# start jupyter
jupyter notebook /notebook/destination/dir
Configuration
In order to connect to your graph database, you have three configuration options.
- Change the host setting in your opened jupyter notebook by running the following in a notebook cell:
%graph_notebook_host you-endpoint-here
- Change your configuration entirely grabbing the current configuration, making edits, and saving it to your notebook by running the following cells:
# 1. print your configuration
%graph_notebook_config
# default config will be printed if nothing else is set:
{
"host": "change-me",
"port": 8182,
"auth_mode": "DEFAULT",
"iam_credentials_provider_type": "ROLE",
"load_from_s3_arn": "",
"ssl": true,
"aws_region": "us-east-1"
}
# 2. in a new cell, change the configuration by using %%graph_notebook_config (note the two leading %% instead of one)
%%graph_notebook_config
{
"host": "changed-my-endpoint",
"port": 8182,
"auth_mode": "DEFAULT",
"iam_credentials_provider_type": "ENV",
"load_from_s3_arn": "",
"ssl": true,
"aws_region": "us-east-1"
}
- Store a configuration under ~/graph_notebook_config.json
echo "{
"host": "changed-my-endpoint",
"port": 8182,
"auth_mode": "DEFAULT",
"iam_credentials_provider_type": "ENV",
"load_from_s3_arn": "",
"ssl": true,
"aws_region": "us-east-1"
}" >> ~/graph_notebook_config.json
Authentication
If you are running a SigV4 authenticated endpoint, ensure that the config field iam_credentials_provider_type
is set
to ENV
and that you have set the following environment variables:
- AWS_ACCESS_KEY_ID
- AWS_SECRET_ACCESS_KEY
- AWS_REGION
- AWS_SESSION_TOKEN (OPTIONAL. Use if you are using temporary credentials)
Security
See CONTRIBUTING for more information.
License
This project is licensed under the Apache-2.0 License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
graph-notebook-1.32.0.tar.gz
(5.2 MB
view hashes)
Built Distribution
Close
Hashes for graph_notebook-1.32.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61fb3891c9d7f450fdf600be4c13df3a19e109f5bf74d4e4db0fea8905161895 |
|
MD5 | 74d0d40d12c62c8ddf9697eba065ecb4 |
|
BLAKE2b-256 | bc5f2047c3c35a5bfa1b7cbf3bf72d5ef982c356012ffd5f1fea626458662942 |