# Follow the Money
[](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`.
Raw data
{
"_id": null,
"home_page": "https://followthemoney.tech/",
"name": "followthemoney",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Organized Crime and Corruption Reporting Project",
"author_email": "data@occrp.org",
"download_url": "https://files.pythonhosted.org/packages/0f/1f/45cbc30940c802f19f0d07067cc22ba1424766398742f9877030da12904c/followthemoney-3.6.0.tar.gz",
"platform": null,
"description": "# Follow the Money\n\n[](https://github.com/alephdata/followthemoney/actions/workflows/build.yml)\n\nThis repository contains a pragmatic data model for the entities most\ncommonly used in investigative reporting: people, companies, assets,\npayments, court cases, etc.\n\nThe purpose of this is not to model reality in an ideal data model, but\nrather to have a working data structure for researchers.\n\n`followthemoney` also contains code used to validate and normalize many\nof the elements of data, and to map tabular data into the model.\n\n## Documentation\n\nFor a general introduction to `followthemoney`, check the high-level introduction:\n\n* https://followthemoney.tech\n\nPart of this package is a command-line tool that can be used to process and\ntransform data in various ways. You can find a tutorial here:\n\n* https://followthemoney.tech/docs/cli/\n\nBesides the introductions, there is also a full reference documentation for the\nlibrary and the contained ontology: \n\n* https://followthemoney.tech/explorer/\n\nThere's also a number of viewers for the RDF schema definitions generated\nfrom FollowTheMoney, e.g.:\n\n* [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)\n* [WebVOWL](https://service.tib.eu/webvowl/#iri=https://alephdata.github.io/followthemoney/ns/ftm.xml)\n* RDF/OWL specification in [XML](https://alephdata.github.io/followthemoney/ns/ftm.xml).\n\n## Development environment\n\nFor local development with a virtualenv:\n\n```bash\npython3 -mvenv .env\nsource .env/bin/activate\npip install -e \".[dev]\"\n```\n\nNow you can run the tests with\n\n```bash\nmake test\n```\n\n## Releasing\n\nWe release a lot of version of `followthemoney` because even small changes\nto the code base require a pypi release to begin being used in `aleph`. To\nthis end, here's the steps for making a release:\n\n```bash\ngit pull --rebase\nmake build\nmake test\ngit add . && git commit -m \"Updating translation files\"\nbumpversion patch\ngit push --atomic origin main $(git describe --tags --abbrev=0)\n```\n\nThis will create a new patch release and upload a distribution of it. If\nthe changes are more significant, you can run `bumpversion` with the `minor`\nor `major` arguments.\n\nWhen the schema is updated, please update the docs, ideally including the\ndiagrams. For the RDF namespace and JavaScript version of the model, \nrun `make generate`.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": null,
"version": "3.6.0",
"project_urls": {
"Homepage": "https://followthemoney.tech/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f0c6515dd85c349f498f64e635feb2186f43f1588332c15e93bcb5cf7fca615f",
"md5": "79f802f8d677eae14882bd16c8534bc8",
"sha256": "4f758a3dfc8fc723253d77bf5da82742193c281c89bf0f30a5c8f44ae80ecc2f"
},
"downloads": -1,
"filename": "followthemoney-3.6.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "79f802f8d677eae14882bd16c8534bc8",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 476756,
"upload_time": "2024-05-08T09:30:59",
"upload_time_iso_8601": "2024-05-08T09:30:59.228748Z",
"url": "https://files.pythonhosted.org/packages/f0/c6/515dd85c349f498f64e635feb2186f43f1588332c15e93bcb5cf7fca615f/followthemoney-3.6.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f1f45cbc30940c802f19f0d07067cc22ba1424766398742f9877030da12904c",
"md5": "21a94d56825b7ccb463430456eea5c30",
"sha256": "5f062e5e2b7bf0d4f5bcae315e4301014c1d4983fdaeeaa65992cc89e0e2407f"
},
"downloads": -1,
"filename": "followthemoney-3.6.0.tar.gz",
"has_sig": false,
"md5_digest": "21a94d56825b7ccb463430456eea5c30",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 404447,
"upload_time": "2024-05-08T09:31:03",
"upload_time_iso_8601": "2024-05-08T09:31:03.277733Z",
"url": "https://files.pythonhosted.org/packages/0f/1f/45cbc30940c802f19f0d07067cc22ba1424766398742f9877030da12904c/followthemoney-3.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-08 09:31:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "followthemoney"
}
JSON