Update documentation

MoravianUniversity · Oct 29, 2024 · a4d141e · a4d141e
1 parent 88092cb
commit a4d141e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git 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
 <details>
@@ -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