-
Notifications
You must be signed in to change notification settings - Fork 1
/
setup.py
77 lines (58 loc) · 2.01 KB
/
setup.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# from distutils.core import setup
from setuptools import setup
setup(
name="cypher_kernel",
version="0.3.2",
packages=["cypher_kernel"],
description="A Cypher kernel for Jupyter",
long_description="""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.
""",
author="HelgeCPH",
author_email="ropf@itu.dk",
url="https://github.com/HelgeCPH/cypher_kernel",
install_requires=["jupyter_client==5.2.2", "IPython", "ipykernel", "requests", "jinja2", "pyyaml", "neo4j"],
include_package_data=True,
classifiers=[
"Development Status :: 3 - Alpha",
"Intended Audience :: Education",
"Intended Audience :: Developers",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
"Operating System :: MacOS :: MacOS X",
"Operating System :: Microsoft :: Windows",
"Operating System :: POSIX",
"Programming Language :: Python :: 3",
],
)