semvec/pypi-packages huggingface dataset:
cypher-kernel 0.3.2
A Cypher kernel for Jupyter

Cypher Kernel
=============

This is a Cypher kernel for Jupyter notebooks.

Installation
------------

To install the ``cypher_kernel`` from PyPI:

.. code:: bash

   pip install cypher_kernel
   python -m cypher_kernel.install


Dependencies
~~~~~~~~~~~~

The kernel requires a Neo4j database engine running somewhere. For experimentation and under the assumption that Docker is installed, an instance can be spawned as in the following:

.. code:: bash

   docker run        --rm        --publish=7474:7474        --publish=7687:7687        --env NEO4J_AUTH=neo4j/pwd        neo4j



Configuration
-------------

The Cypher Kernel needs to know to which Neo4j instance to connect, which can be specified in ``~/.jupyter/cypher_config.yml``. In case the file is not existent the following default
configuration is used:

.. code:: yaml

   user: 'neo4j'
   pwd: 'pwd'
   host: 'neo4j://localhost:7687'
   connect_result_nodes: False
   cmd_timeout: null

Using the Cypher Kernel
-----------------------

**Notebook**: The *New* menu in the notebook should show an option for
an ``Cypher`` notebook.