Client-facing API to interact with anonlink system including command line tools and Rest API communication. Anonlink system needs the following three components to work together:
This package provides an easy-to-use API to interact with the above packages to complete a record linkage job.
The way to interact with anonlink system is via Command Line Tool anonlink
. You can encode data containing PI (Personal
Identifying Information) locally using anonlink encode
and generate candidate blocks locally to scale up record linkage
using anonlink block
.
Install with pip/poetry etc.:
pip install anonlink-client
https://anonlink-client.readthedocs.io/en/stable/
After installation, you should have a anonlink
program in your path. For
example, to encode PII data alice.csv
locally with schema schema.json
and secret horse
, run:
$ anonlink encode 'alice.csv' 'horse' 'schema.json' 'encoded-entities.json'
It will generate the CLK output and store in clk.json
. To find out how to define the schema
for your PII data, please refer this page for
details.