Skip to content

dataresearchcenter/investigraph-etl

Repository files navigation

investigraph on pypi Python test and package Build docker container pre-commit Coverage Status MIT License

investigraph

An ETL framework for building datasets in the FollowTheMoney format for investigative journalism and research.

Documentation

Tutorial

installation

investigraph requires at least Python 3.11

pip install investigraph

example datasets

There is a dedicated repo for example datasets built with investigraph.

deployment

docker

docker-compose.yml for local development / testing, use docker-compose.prod.yml as a starting point for a production setup. More instructions here

run locally

Install app and dependencies (use a virtualenv):

pip install investigraph

Or, e.g. when using poetry:

poetry add investigraph

After installation, investigraph as a command should be available:

investigraph --help

Quick run a local dataset definition:

investigraph run -c ./path/to/config.yml

development

This package is using poetry for packaging and dependencies management, so first install it.

Clone investigraph repository to a local destination.

Within the root directory, run

poetry install --with dev

This installs a few development dependencies, including pre-commit which needs to be registered:

poetry run pre-commit install

Before creating a commit, this checks for correct code formatting (isort, black) and some other useful stuff (see: .pre-commit-config.yaml)

test

make test

supported by

Media Tech Lab Bayern batch #3

About

etl pipeline for follow the money data based on prefect.io

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 2

  •  
  •