Skip to main content

etl pipeline for investigations with follow the money data

Project description

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

investigraph

Research and implementation of an ETL process for a curated and up-to-date public and open-source data catalog of frequently used datasets in investigative journalism.

Using prefect.io for ftm pipeline processing

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

View prefect dashboard:

make server

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

investigraph-0.5.2.tar.gz (18.6 kB view details)

Uploaded Source

Built Distribution

investigraph-0.5.2-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

Details for the file investigraph-0.5.2.tar.gz.

File metadata

  • Download URL: investigraph-0.5.2.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.0 CPython/3.11.8 Linux/6.6.15-amd64

File hashes

Hashes for investigraph-0.5.2.tar.gz
Algorithm Hash digest
SHA256 d13ba5f38625091a88396e946fd00a194ce11828880c04ce0cdff978334856b3
MD5 57283ddff95506f6393e212efea0b46d
BLAKE2b-256 098e7f890fd025952e22850ee61d858d263c5cf4b69d1211fa19655e44b32425

See more details on using hashes here.

File details

Details for the file investigraph-0.5.2-py3-none-any.whl.

File metadata

  • Download URL: investigraph-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 24.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.0 CPython/3.11.8 Linux/6.6.15-amd64

File hashes

Hashes for investigraph-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d7a00b720f51736ecf1630c3cbf57c5702a0d028a7d749e5bd5d8a73fcdf7d1e
MD5 37b47c73cf9b5504ab66c83c34d210b7
BLAKE2b-256 a24eea3256e090bf6dfd3f1ee5828dd3cb07d76e1725d841e01bebce22e032b4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page