https://github.com/danymat/insanonym-utils

Execute anonymization scripts on a table.
https://github.com/danymat/insanonym-utils

anonymization

Last synced: about 1 month ago
JSON representation

Execute anonymization scripts on a table.

• Host: GitHub
• URL: https://github.com/danymat/insanonym-utils
• Owner: danymat
• License: gpl-3.0
• Created: 2021-04-19T11:50:11.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-12T10:58:11.000Z (about 3 years ago)
• Last Synced: 2024-05-02T04:27:57.478Z (6 months ago)
• Topics: anonymization
• Language: Python
• Homepage: https://danymat.github.io/INSAnonym-utils
• Size: 828 KB
• Stars: 8
• Watchers: 3
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![](.images/INSA-3.png)

INSA'nonym-utils is a python library capable of doing operations on a table.

At the moment, it is capable of:

- Creating a DataFrame from the table.

- Execute multiple algorithms on the table.

- Execute algorithms created by the user.

- Export the resulting Dataframe with the specified format.

## Installation

Installation is compatible with python versions `3.8` and `3.9`.

```bash

pip install insanonym-utils

```

In order to upgrade to latest version:

```bash

pip install insanonym-utils --upgrade

```

Version informations are in the github [Releases](https://github.com/danymat/INSAnonym-utils/releases).

## Documentation

- [First steps](https://github.com/danymat/INSAnonym-utils/blob/main/docs/premiers-pas.md)

- In order to know more about pre-defined algorithms, please see [Algorithms](docs/algorithmes.md).

- In order to understand how to create your own algorithm, please see [Algorithms Creation](docs/creation-algorithmes.md).

- In order to see source code documentation, please follow the docs [INSAnonym-utils](https://danymat.github.io/INSAnonym-utils).

## INSAnonym Related Documentation

- To know the utility metrics used in the competition, please see [Metrics](https://github.com/danymat/INSAnonym-utils/blob/main/docs/insanonym-metrics.md).

- [User guide](https://github.com/danymat/INSAnonym-utils/blob/main/docs/user-documentation-insanonym.md)

- [Attack file example](https://github.com/danymat/INSAnonym-utils/blob/main/insanonym_utils/F_user_7_0d54717e83a17d6eb39491c4a3f9eaa27a776572b769f9c7af6c23195f70fa6c)

## Development

Prerequisites:

- [Poetry](https://python-poetry.org/docs/#installation)

```

git clone https://github.com/danymat/INSAnonym-utils.git

cd INSAnonym-utils

poetry install

```

Run the tests:

```bash

cd tests

poetry run pytest

```

## Roadmap

[Roadmap](https://github.com/danymat/INSAnonym-utils/projects/1).