diff --git a/docs/scripts.md b/docs/scripts.md index 9b4fd565..e809ad1e 100644 --- a/docs/scripts.md +++ b/docs/scripts.md @@ -14,6 +14,8 @@ Currently, the following scripts are provided. * correct possible errors within a counts json file generated by `get_counts.py` * `set_counts.py` * set values in a mirrulations Redis instance using json generated by `get_counts.py` +* `get_correct_set.sh` + * run `get_counts.py`, `correct_counts.py`, and `set_counts.py`, logging relevant information All of the scripts above share a common format
@@ -47,6 +49,12 @@ All of the scripts above share a common format ## Description +### `get_correct_set.sh` + +`get_correct_set.sh` gets counts using `get_counts.py` from Redis, corrects them using `correct_counts.py`, and on success sets them using `set_counts.py`. +It attempts to log to `/var/log/mirrulations_counts.log`. +By default, it expects a virtual environment with all required dependencies in `/home/cs334/mirrulations/scripts/.venv`. + ### `get_counts.py` `get_counts.py` gets counts from one of three sources: regulations.gov, a Mirrulations Redis instance, a Mirrulations dashboard via HTTP. diff --git a/scripts/get_correct_set.sh b/scripts/get_correct_set.sh old mode 100644 new mode 100755