Skip to main content

Client side tool for clkhash and blocklib

Project description

codecov Documentation Status Build Status Requirements Status Downloads

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for anonlink-client, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size anonlink_client-0.1.1-py3-none-any.whl (19.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size anonlink-client-0.1.1.tar.gz (13.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page