followthemoney-neomodel

Models followthemoney Schemas into neomodel ogm classes

On the fly creation of classes for nodes and edges based on follow the money schema

Classes can be directly imported and used to create objects in a neo4j graph and traverse the graph

Setup

Requires followthemoney and neomodel. Any version of followthemoney will work as

pip install followthemoney-neomodel

This takes any version of followthemoney and will model whatever schemas are defined in that version

Usage

Basic

Just import and use classes directly to create objects

from followthemoney_neomodel import Person, Vehicle

# create two edges based on Person and Vehicle schema
me = Person(name='me')
me.save()

car = Vehicle(name='honda')
car.save()

# connect the two nodes together with edge OWNERSHIP relation and properties
me.owns.connect(car, {'role': 'lease'})

The module also has a models dict that you can use instead of importing to reference all models created

from followthemoney_neomodel import models

me = models['Person'](name='me')

Person.nodes.traverse("owns__name").all()

Async

Want async support? The modeler also sets up matching Async* classes

from followthemoney_neomodel import AsyncPerson

async def main():
    me = Person(name='me')
    await me.save()

    car = Vehicle(name='honda')
    await car.save()

    await me.owns.connect(car, {'role': 'lease'})

Output

Generates a simple graph

Then you can query the graph using traversal syntax from neomodel

Testing

Run these tests on a dev neo4j instance/database as it will create nodes/edges which can pollute your graph.

Set NEOMODEL_DATABASE_URL env var to define destination db for testing

git clone ...
cd followthemoney-neomodel
poetry install -G dev
poetry run pytest tests.py