Metadata-Version: 2.1
Name: clkhash
Version: 0.16.0a1
Summary: Encoding utility to create Cryptographic Linkage Keys
Home-page: https://github.com/data61/clkhash
License: Apache
Project-URL: Documentation, http://clkhash.readthedocs.io/
Project-URL: Source, https://github.com/data61/clkhash
Project-URL: Tracker, https://github.com/data61/clkhash/issues
Description: # CLK Hash
        
        Python implementation of cryptographic longterm key hashing. `clkhash` supports Python versions 2.7+, 3.5+
        
        This is as described by Rainer Schnell, Tobias Bachteler, and Jörg Reiher in
        [A Novel Error-Tolerant Anonymous Linking Code](http://grlc.german-microsimulation.de/wp-content/uploads/2017/05/downloadwp-grlc-2011-02.pdf)
        
        [![codecov](https://codecov.io/gh/data61/clkhash/branch/master/graph/badge.svg)](https://codecov.io/gh/data61/clkhash)
        [![Documentation Status](https://readthedocs.org/projects/clkhash/badge/?version=latest)](http://clkhash.readthedocs.io/en/latest/?badge=latest)
        [![Build Status](https://travis-ci.org/data61/clkhash.svg?branch=master)](https://travis-ci.org/data61/clkhash)
        [![Build Status](https://dev.azure.com/data61/Anonlink/_apis/build/status/data61.clkhash?branchName=master)](https://dev.azure.com/data61/Anonlink/_build/latest?definitionId=2&branchName=master)
        [![Requirements Status](https://requires.io/github/data61/clkhash/requirements.svg?branch=master)](https://requires.io/github/data61/clkhash/requirements/?branch=master)
        [![Downloads](https://pepy.tech/badge/clkhash)](https://pepy.tech/project/clkhash)
        
        ## Installation
        
        Install clkhash with all dependencies using pip:
        
            pip install clkhash
        
        
        ## Documentation
        
        [https://clkhash.readthedocs.io](https://clkhash.readthedocs.io/en/latest/)
        
        
        ## clkhash api
        
        To hash a CSV file of entities using the default schema:
        
        ```python
        from clkhash import clk, randomnames
        fake_pii_schema = randomnames.NameList.SCHEMA
        clks = clk.generate_clk_from_csv(open('fake-pii-out.csv','r'), 'secret', fake_pii_schema)
        ```
        
        ## Citing
        
        Clkhash, and the wider Anonlink project is designed, developed and supported by 
        `CSIRO's Data61 <https://www.data61.csiro.au/>`__. If you use any part of this library in your research, please 
        cite it using the following BibTex entry::
        
            @misc{Anonlink,
              author = {CSIRO's Data61},
              title = {Anonlink Private Record Linkage System},
              year = {2017},
              publisher = {GitHub},
              journal = {GitHub Repository},
              howpublished = {\url{https://github.com/data61/clkhash}},
            }
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
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
