Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alephdata/followthemoney
Data model and processing tools for investigative entity data
https://github.com/alephdata/followthemoney
entities journalism ontology
Last synced: 3 months ago
JSON representation
Data model and processing tools for investigative entity data
- Host: GitHub
- URL: https://github.com/alephdata/followthemoney
- Owner: alephdata
- License: mit
- Created: 2017-10-20T09:02:52.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-07-30T17:41:39.000Z (6 months ago)
- Last Synced: 2024-07-30T21:56:55.407Z (6 months ago)
- Topics: entities, journalism, ontology
- Language: Python
- Homepage: https://followthemoney.tech
- Size: 14.2 MB
- Stars: 206
- Watchers: 22
- Forks: 48
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - alephdata/followthemoney - Data model and processing tools for investigative entity data (others)
README
# Follow the Money
[![ftm-build](https://github.com/alephdata/followthemoney/actions/workflows/build.yml/badge.svg)](https://github.com/alephdata/followthemoney/actions/workflows/build.yml)
This repository contains a pragmatic data model for the entities most
commonly used in investigative reporting: people, companies, assets,
payments, court cases, etc.The purpose of this is not to model reality in an ideal data model, but
rather to have a working data structure for researchers.`followthemoney` also contains code used to validate and normalize many
of the elements of data, and to map tabular data into the model.## Documentation
For a general introduction to `followthemoney`, check the high-level introduction:
* https://followthemoney.tech
Part of this package is a command-line tool that can be used to process and
transform data in various ways. You can find a tutorial here:* https://followthemoney.tech/docs/cli/
Besides the introductions, there is also a full reference documentation for the
library and the contained ontology:* https://followthemoney.tech/explorer/
There's also a number of viewers for the RDF schema definitions generated
from FollowTheMoney, e.g.:* [LODE documentation](http://150.146.207.114/lode/extract?url=https%3A%2F%2Falephdata.github.io%2Ffollowthemoney%2Fns%2Fftm.xml&owlapi=true&imported=true&lang=en)
* [WebVOWL](https://service.tib.eu/webvowl/#iri=https://alephdata.github.io/followthemoney/ns/ftm.xml)
* RDF/OWL specification in [XML](https://alephdata.github.io/followthemoney/ns/ftm.xml).## Development environment
For local development with a virtualenv:
```bash
python3 -mvenv .env
source .env/bin/activate
pip install -e ".[dev]"
```Now you can run the tests with
```bash
make test
```## Releasing
We release a lot of version of `followthemoney` because even small changes
to the code base require a pypi release to begin being used in `aleph`. To
this end, here's the steps for making a release:```bash
git pull --rebase
make build
make test
git add . && git commit -m "Updating translation files"
bumpversion patch
git push --atomic origin main $(git describe --tags --abbrev=0)
```This will create a new patch release and upload a distribution of it. If
the changes are more significant, you can run `bumpversion` with the `minor`
or `major` arguments.When the schema is updated, please update the docs, ideally including the
diagrams. For the RDF namespace and JavaScript version of the model,
run `make generate`.