piianalyzer 0.1.0

PII Analyzer
===========
Analyzing PII in datasets


Classifying datasets and resources into ‘PII’ and ‘Not PII’.
===========

The task requires creation of a tool that will detect whether new datasets uploaded to HDX contain any personally
identifiable information - data that can be used on its own or with other information to identify, contact, or
locate a single person, or to identify an individual in context.

The tool should then alert the HDX data manager whether any such data sets have been uploaded
and also alert the data owner about this.

My Solution
----

I decided to use the following tools for the above task:

1. `Pandas <https://github.com/pydata/pandas>`_: for reading the data files into python and manipulating the datasets.

2. `Common Regular expressions <https://github.com/madisonmay/CommonRegex>`_: for extracting some types of 'PII' such as email addresses, phone numbers, street addresses,
credit card numbers,

3. `Stanford Named Entity Tagger <http://nlp.stanford.edu/software/CRF-NER.shtml>`_: for extracting the locations, organizations and peoples names.


The analyzer opens the provided file, analyses it and returns a summary of the types of data that are in the provided dataset.
With this information the data manager can easily classify the data.


Usage
-----


>>> from piianalyzer.analyzer import PiiAnalyzer
>>> filepath = '/path/or/url/to/your/file.csv'
>>> piianalyzer = PiiAnalyzer(filepath)
>>> analysis = piianalyzer.analysis()



Installation
------------



Requirements
^^^^^^^^^^^^

Requires the Stanford Named Entity Recognizer. It can be downloaded here: http://nlp.stanford.edu/software/CRF-NER.shtml


Compatibility
-------------

Licence
-------

TODO
----
* Reading other file types such as excel, text, html etc
*

Authors
-------

`piianalyzer` was written by `Savio Abuga <savioabuga@gmail.com>`_.