Metadata-Version: 2.1
Name: followthemoney
Version: 1.30.2
Summary: UNKNOWN
Home-page: https://docs.alephdata.org/developers/followthemoney
Author: Organized Crime and Corruption Reporting Project
Author-email: data@occrp.org
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: babel
Requires-Dist: pyyaml
Requires-Dist: banal (>=0.4.2)
Requires-Dist: click (>=7.0)
Requires-Dist: stringcase (>=1.2.0)
Requires-Dist: requests (>=2.21.0)
Requires-Dist: python-levenshtein (>=0.12.0)
Requires-Dist: normality (>=2.0.0)
Requires-Dist: sqlalchemy (>=1.2.0)
Requires-Dist: countrynames (>=1.6.0)
Requires-Dist: languagecodes (>=1.0.4)
Requires-Dist: phonenumbers (>=8.9.11)
Requires-Dist: python-stdnum (>=1.10)
Requires-Dist: urlnormalizer (>=1.2.0)
Requires-Dist: pantomime (>=0.3.2)
Requires-Dist: pytz (>=2018.5)
Requires-Dist: rdflib (>=4.2.2)
Requires-Dist: networkx (>=2.4)
Requires-Dist: openpyxl (>=3.0.3)
Requires-Dist: ordered-set (>=3.1.1)
Provides-Extra: dev
Requires-Dist: pip (>=10.0.0) ; extra == 'dev'
Requires-Dist: bumpversion (>=0.5.3) ; extra == 'dev'
Requires-Dist: wheel (>=0.29.0) ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: flake8 (>=2.6.0) ; extra == 'dev'
Requires-Dist: nose ; extra == 'dev'
Requires-Dist: transifex-client ; extra == 'dev'
Requires-Dist: responses (>=0.9.0) ; extra == 'dev'
Requires-Dist: coverage (>=4.1) ; extra == 'dev'
Requires-Dist: recommonmark (>=0.4.0) ; extra == 'dev'

# Follow the Money

[![Build Status](https://travis-ci.org/alephdata/followthemoney.png?branch=master)](https://travis-ci.org/alephdata/followthemoney)

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 main documentation:

* https://docs.alephdata.org/developers/followthemoney

Part of this package is a command-line tool that can be used to process and
transform data in various ways. This is documented here:

* https://docs.alephdata.org/developers/ftm

There's no built-in tooling to render the model metadata (i.e. the list of
schemata). However, we can export the schema to RDF (RDF/OWL), the abstract
data model behind linked data. There's 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](http://www.visualdataweb.de/webvowl/#iri=https://alephdata.github.io/followthemoney/ns/ftm.xml)
* Raw RDF, [XML](https://alephdata.github.io/followthemoney/ns/ftm.xml) or 
  [Turtle](https://alephdata.github.io/followthemoney/ns/ftm.ttl)

## 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 test
bumpversion patch
git push --tags
```

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`.


