tamarind is a system that manages Neo4j databases by provisioning Docker container resources for you. The user-facing API provides access to a dictionary-like lookup for your databases, and allows you to start and stop database servers on the fly.

Install from PyPI using pip:

pip3 install tamarind

You will need Docker already installed if you intend to use the Docker provisioning service. You can install Docker with the script from https://get.docker.com/.

from tamarind import Neo4jDockerProvisioner

N = Neo4jDockerProvisioner()

N.start("MyDatabase")

Now you can access this graph database through py2neo:

>>> N["MyDatabase"]
<py2neo.Graph>

The object returned is a py2neo.database.Graph object:

>>> N["MyDatabase"].run("MATCH (a:Person) RETURN a.name, a.born LIMIT 4").data()
[{'a.born': 1964, 'a.name': 'Keanu Reeves'},
 {'a.born': 1967, 'a.name': 'Carrie-Anne Moss'},
 {'a.born': 1961, 'a.name': 'Laurence Fishburne'},
 {'a.born': 1960, 'a.name': 'Hugo Weaving'}]

>>> N.ps().keys()
['MyDatabase', 'OldDatabase']

>>> N.stop("OldDatabase")
>>> N.ps().keys()
['MyDatabase']

If you provision Neo4j instances via resources other than Docker (e.g. via AWS EC2 AMIs), you can extend the Neo4jProvisioner class with start and ps function calls (stop is an optional implementation in Tamarind).

Licensed under Apache 2.0.

Copyright 2024 Johns Hopkins University Applied Physics Laboratory

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this codebase except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.