Metadata-Version: 2.1
Name: anonlink-client
Version: 0.0.1
Summary: Client side tool for clkhash and blocklib
Home-page: https://github.com/data61/anonlink-client
License: Apache
Project-URL: Documentation, https://github.com/data61/anonlink-client
Project-URL: Source, https://github.com/data61/anonlink-client
Project-URL: Tracker, https://github.com/data61/anonlink-client/issues
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Security :: Cryptography
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Description-Content-Type: text/markdown
Requires-Dist: anonlink (>=0.12.5)
Requires-Dist: clkhash (>=0.14.0)
Requires-Dist: jsonschema (>=3.0.2)
Requires-Dist: numpy (>=1.17.0)
Requires-Dist: pandas (>=0.25.2)
Requires-Dist: pytest (>=5.2.1)
Requires-Dist: requests (>=2.22.0)


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

* [clkhash](https://github.com/data61/clkhash)
* [blocklib](https://github.com/data61/blocklib)
* [anonlink-entity-service](https://github.com/data61/anonlink-entity-service)

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:

```python3
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:
```bash
$ 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](https://clkhash.readthedocs.io/en/stable/schema.html) for 
details.



