Metadata-Version: 2.1
Name: anonlink-client
Version: 0.1.2
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
Description: [![codecov](https://codecov.io/gh/data61/anonlink-client/branch/master/graph/badge.svg)](https://codecov.io/gh/data61/anonlink-client)
        [![Documentation Status](https://readthedocs.org/projects/anonlink-client/badge/?version=latest)](http://anonlink-client.readthedocs.io/en/latest/?badge=latest)
        ![Build Status](https://dev.azure.com/data61/Anonlink/_apis/build/status/data61.anonlink-client?branchName=master)
        [![Requirements Status](https://requires.io/github/data61/anonlink-client/requirements.svg?branch=master)](https://requires.io/github/data61/anonlink-client/requirements/?branch=master)
        [![Downloads](https://pepy.tech/badge/anonlink-client)](https://pepy.tech/project/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://anonlink-client.readthedocs.io/en/stable/
        
        ### 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.
        
        
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
