Client side tool for clkhash and blocklib
Project description
.. image:: https://codecov.io/gh/data61/anonlink-client/branch/master/graph/badge.svg :target: https://codecov.io/gh/data61/anonlink-client
Anonlink Client
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 hash data containing PII (Personal
Identifying Information) locally using anonlink hash
, generate candidate blocks locally to scale up record linkage
using anonlink block
, create a record linkage job in entity service with anonlink create-project
etc.
Installation
Currently manual install:
pip install anonlink-client
Documentation
https://clkhash.readthedocs.io/en/stable/cli.html Note that the documentation are for clkhash now, we will add a readthedocs page for anonlink-client very soon.
CLI Tool
After installation, you should have a anonlink
program in your path. For
example, to hash PII data alice.csv
locally with schema schema.json
and secret horse
, run:
$ anonlink hash '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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for anonlink_client-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43cc8e222429e7cc7661d1d57097c0eb35afa400ce8ea4a887cf3ae7eca78556 |
|
MD5 | 5061b4f22a42ad952b1bd1376a777d07 |
|
BLAKE2b-256 | f86021c9ec9328a71fabb562df381453b9a8d0d821b61f8ab7126c215d6ed1b5 |