jupyter notebook extension to connect to graph databases
Reason this release was yanked:
dev release
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
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
Built Distribution
Close
Hashes for graph-notebook-1.31.7.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 350cbac7ebec61d1e82bf56cbf119391a4b42e125bbe422cb28461db964dec1c |
|
MD5 | 6c80fa5309cd3c3615692fb49fbdd189 |
|
BLAKE2b-256 | 1c5245fdd85439defcadc24ecc55e6fad00533dbfc9ddb4abdd716609022250d |
Close
Hashes for graph_notebook-1.31.7.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 501ecddecb51378240030999c3922ff6635b9015ef1ba24b6a87c4b8e6e6165a |
|
MD5 | e1db7cf723043b5bca4d1e0f46a91ece |
|
BLAKE2b-256 | 4f906631ed8093a8efba32e170d884a54b98489b43edb02a2e4f88c7d44e4d59 |