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
- Python 3.6.1 or higher, Python 3.7
- 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.33.0.dev0.tar.gz
(61.5 MB
view hashes)
Built Distribution
Close
Hashes for graph-notebook-1.33.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01924b5d4f66c6a50020c1b8c4adbeb8ea3732e9c2cf82b7196be340c402b88a |
|
MD5 | c6007e9b499c098a9fb62a2be8f40715 |
|
BLAKE2b-256 | 455328f68888b39864f7aa838d6bf45f32025dc516785a48756c262b3eb85632 |
Close
Hashes for graph_notebook-1.33.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b243cb3785a188c925512ad264e6700191fa5fd58b9770fe60c3fc51674f0482 |
|
MD5 | 92df48a3605f1d7637efcd939c74ae55 |
|
BLAKE2b-256 | f4eb42d6658cb4197e69a827cde5c717b6fdd161c91b6a2808e618c36f97840b |