Metadata-Version: 2.1
Name: gda-score-code
Version: 2.2.5
Summary: Tools for generating General Data Anonymity Scores (www.gda-score.org)
Home-page: https://github.com/gda-score/code
Author: Paul Francis
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: numpy (>=1.16.0)
Requires-Dist: pprint (>=0.1)
Requires-Dist: matplotlib (>=3.0.2)
Requires-Dist: python-dateutil (>=2.7.5)
Requires-Dist: simplejson (>=3.16.0)
Requires-Dist: psycopg2 (>=2.8.3)
Requires-Dist: PyInquirer (==1.0.3)
Requires-Dist: pyfiglet (==0.8.post1)


# code  

This repo holds a variety of tools in support of the GDA Score Project (General Data Anonymity Score Project).  

The code here is still very much alpha, and little effort has gone into making it easy for others to install and use.  

The primary language is Python, and requires Python3.7 or later. API documentation for some of the tools can be found at https://gda-score.github.io/.  

## To run  

There are 2 possible ways of using this program:  

1. #### Installing via `pip`:  
   - step 1: `$ pip install gda-score-code`  

   - step 2: if you would like to stick to default configuration then skip this step. otherwise try executing `$ gdascore_init` in your console  to modify the configuration.  

   - step 3: use following import statements in your code:  
	   ```python  
	   from gdascore.gdaScore import gdaAttack, gdaScores  
	   from gdascore.gdaUtilities import *
	   from gdascore.gdaQuery import *
	   ```  

2. #### Cloning the repository:  

   This repo has executable .py files in a variety of locations, most notably ./attacks and ./utility.  

   There are libraries and configuration files located under ./common.  

   To run these executables, the environment variable `PYTHONPATH` must be set to the path to the repo. (For example,      `PYTHONPATH=C:\Users\francis\Documents\GitHub\code;`)  


## Repo Organization  

This repo is organized as follows:  

### anon-methods  

Contains tools to implement new anonymization methods.  

### attacks  

Contains all of the attacks on the various anonymization methods.  

### common  

Contains general support code.  

### graphs  

Contains tools to generate diagrams of the attack and utility scores.  

### utility  

Contains tools to measure the utility of various anonymization methods

