63 lines
1.9 KiB
Markdown
63 lines
1.9 KiB
Markdown
|
# dimocracy-voucher
|
||
|
|
|
||
|
|
Automation tools for running dimocracy
|
||
|
|
|
||
|
|
## Getting started
|
||
|
|
|
||
|
|
### Requirements
|
||
|
|
|
||
|
|
- [Python](https://python.org/) > 3.11
|
||
|
|
- [Poetry](https://python-poetry.org/)
|
||
|
|
|
||
|
|
### Installation
|
||
|
|
|
||
|
|
```sh
|
||
|
|
cd dimocracy-voucher
|
||
|
|
poetry install
|
||
|
|
poetry shell
|
||
|
|
python ./anonymize_entries.py path/to/folder
|
||
|
|
```
|
||
|
|
|
||
|
|
### Help contents
|
||
|
|
|
||
|
|
```
|
||
|
|
usage: anonymize_entries.py [-h] [-c CSV] [-f FILE_UPLOADS] [-d | --dry-run | --no-dry-run] [-D | --deanonymized | --no-deanonymized] [-e EMAILS] [-o OUTPUT]
|
||
|
|
[-r | --regenerate | --no-regenerate] [-s SEED]
|
||
|
|
[data_dir]
|
||
|
|
|
||
|
|
positional arguments:
|
||
|
|
data_dir directory containing both the CSV form data and the file responses (uploads)
|
||
|
|
|
||
|
|
options:
|
||
|
|
-h, --help show this help message and exit
|
||
|
|
-c CSV, --csv CSV override path to the CSV file of form responses
|
||
|
|
-f FILE_UPLOADS, --file-uploads FILE_UPLOADS
|
||
|
|
override path to the directory of file responses (uploads)
|
||
|
|
-d, --dry-run, --no-dry-run
|
||
|
|
do not create or modify any files
|
||
|
|
-D, --deanonymized, --no-deanonymized
|
||
|
|
skip anonymization of files, simply package them as-is
|
||
|
|
-e EMAILS, --emails EMAILS
|
||
|
|
limit output to files from the specified emails (comma-separated)
|
||
|
|
-o OUTPUT, --output OUTPUT
|
||
|
|
output directory
|
||
|
|
-r, --regenerate, --no-regenerate
|
||
|
|
force-update generated CSV columns
|
||
|
|
-s SEED, --seed SEED specify random seed for alias generation (treat this like a password & change it for each round)
|
||
|
|
|
||
|
|
example:
|
||
|
|
|
||
|
|
path/to/folder:
|
||
|
|
├ form_responses.csv
|
||
|
|
└ file_responses/
|
||
|
|
├ Upload A - User 1.zip
|
||
|
|
├ Upload B - User 2.zip
|
||
|
|
└ etc.
|
||
|
|
|
||
|
|
python ./anonymize_entries.py path/to/folder
|
||
|
|
|
||
|
|
OR
|
||
|
|
|
||
|
|
python ./anonymize_entries.py -c path/to/folder/form_responses.csv -f path/to/folder/file_responses
|
||
|
|
```
|