Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/intenthq/anon
A UNIX Command To Anonymise Data
https://github.com/intenthq/anon
anonymity anonymization cli csv data go golang
Last synced: about 2 months ago
JSON representation
A UNIX Command To Anonymise Data
- Host: GitHub
- URL: https://github.com/intenthq/anon
- Owner: intenthq
- License: mit
- Archived: true
- Created: 2018-05-17T10:36:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-04-01T13:17:39.000Z (over 5 years ago)
- Last Synced: 2024-07-03T10:19:29.949Z (3 months ago)
- Topics: anonymity, anonymization, cli, csv, data, go, golang
- Language: Go
- Homepage:
- Size: 43 KB
- Stars: 354
- Watchers: 35
- Forks: 14
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Anon — A UNIX Command To Anonymise Data
[](https://travis-ci.org/intenthq/anon)
[](https://goreportcard.com/report/github.com/intenthq/anon) [](https://github.com/intenthq/anon/LICENSE)
Anon is a tool for taking delimited files and anonymising or transforming columns until the output is useful for applications where sensitive information cannot be exposed.
## Installation
Releases of Anon are available as pre-compiled static binaries [on the corresponding GitHub release](https://github.com/intenthq/anon/releases). Simply download the appropriate build for your machine and make sure it's in your `PATH` (or use it directly).
## Usage
```sh
anon [--config ]
[--output ]
```
Anon is designed to take input from `STDIN` and by default will output the anonymised file to `STDOUT`:
```sh
anon < some_file.csv > some_file_anonymised.csv
```
### Configuration
In order to be useful, Anon needs to be told what you want to do to each column of the CSV. The config is defined as a JSON file (defaults to a file called `config.json` in the current directory):
```json5
{
"csv": {
"delimiter": ","
},
// Optionally define a number of rows to randomly sample down to.
// To do it, it will hash (using FNV-1 32 bits) the column with the ID
// in it and will mod the result by the value specified to decide if the
// row is included or not -> include = hash(idColumn) % mod == 0
"sampling": {
// Number used to mod the hash of the id and determine if the row
// has to be included in the sample or not
"mod": 30000
// Specify in which a column a unique ID exists on which the sampling can
// be performed. Indices are 0 based, so this would sample on the first
// column.
"idColumn": 0
},
// An array of actions to take on each column - indices are 0 based, so index
// 0 in this array corresponds to column 1, and so on.
//
// There must be an action for every column in the CSV.
"actions": [
{
// The no-op, leaves the input unchanged.
"name": "nothing"
},
{
// Takes a UK format postcode (eg. W1W 8BE) and just keeps the outcode
// (eg. W1W).
"name": "outcode"
},
{
// Hash (SHA1) the input.
"name": "hash",
// Optional salt that will be appened to the input.
// If not defined, a random salt will be generated
"salt": "salt"
},
{
// Given a date, just keep the year.
"name": "year",
"dateConfig": {
// Define the format of the input date here.
"format": "YYYYmmmdd"
}
},
{
// Summarise a range of values.
"name": "range",
"rangeConfig": {
"ranges": [
// For example, this will take values between 0 and 100, and convert
// them to the string "0-100".
// You can use one of (gt, gte) and (lt, lte) but not both at the
// same time.
// You also need to define at least one of (gt, gte, lt, lte).
{
"gte": 0,
"lt": 100,
"output": "0-100"
}
]
}
}
]
}
```
## Contributing
Any contribution will be welcome, please refer to our [contributing guidelines](CONTRIBUTING.md) for more information.
## License
This project is [licensed under the MIT license](LICENSE).
The icon is by [Pixel Perfect](https://www.flaticon.com/authors/pixel-perfect) from [Flaticon](https://www.flaticon.com/), and is licensed under a [Creative Commons 3.0 BY](http://creativecommons.org/licenses/by/3.0/) license.