API Overview
The API follows an identical structure to the CLI, which has been separated in several modules for ease of use. Importing a class or function from mako therefore can be done as follows:
from mako.scripts.utils import ParentDriver
from mako.scripts.base import BaseDriver
from mako.scripts.neo4biom import Biom2Neo
from mako.scripts.io import IoDriver
from mako.scripts.netstats import NetstatsDriver
from mako.scripts.metastats import MetastatsDriver
from mako.scripts.utils import ParentDriver
For learning more about the parameters used by a driver, type help(driver)
, replacing driver
with the name of the driver you are interested in. Note that all classes have private methods which are not explained here.
All drivers are derived from the ParentDriver class, meaning they share a few parameters that provide information necessary to access the Neo4j database.
filepath
File path for reading / writing files and logencrypted
Toggle encryption, for example by setting to False to interact with Dockeruser
Neo4j usernamepassword
Neo4j passworduri
Neo4j address
For an example of the mako API, please check out the querying demo.