Metadata-Version: 2.1
Name: graph-notebook
Version: 1.32.2
Summary: jupyter notebook extension to connect to graph databases
Home-page: https://github.com/aws/graph-notebook
Author: amazon-neptune
Author-email: amazon-neptune-pypi@amazon.com
License: UNKNOWN
Description: ## graph-notebook
        
        Python package integrating jupyter notebooks with various graph-stores including
        [Apache TinkerPop](https://tinkerpop.apache.org/) and [RDF SPARQL](https://www.w3.org/TR/rdf-sparql-query/).
        
        ## 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.
        
        1. Change the host setting in your opened jupyter notebook by running the following in a notebook cell:
        
        ```
        %graph_notebook_host you-endpoint-here
        ```
        
        2. 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"
        }
        ```
        
        3. 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](https://github.com/aws/graph-notebook/blob/main/CONTRIBUTING.md) for more information.
        
        ## License
        
        This project is licensed under the Apache-2.0 License.
        
        
Keywords: jupyter neptune gremlin sparql
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: Apache Software License
Description-Content-Type: text/markdown
