From 9a3cc6360b88a82d24521694496cdc505ababa3a Mon Sep 17 00:00:00 2001
From: Nathan Hui <nthui@ucsd.edu>
Date: Wed, 18 Sep 2024 15:44:33 -0700
Subject: [PATCH] docs: Adds testing notes

---
 .python-version |  1 +
 README.md       | 24 ++++++++++++++++++++++++
 2 files changed, 25 insertions(+)
 create mode 100644 .python-version

diff --git a/.python-version b/.python-version
new file mode 100644
index 0000000..09dcc78
--- /dev/null
+++ b/.python-version
@@ -0,0 +1 @@
+3.10.11
diff --git a/README.md b/README.md
index 706f5db..d0de8da 100644
--- a/README.md
+++ b/README.md
@@ -1114,3 +1114,27 @@ Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)
 
 The manual labels provided for this dataset are automatically downloaded as a .csv when
 the repository is cloned.
+
+## Testing
+Tests require E4E NAS credentials.  These must be provided as a JSON file, or as an environment variable.
+
+If provided as a JSON file, this file must be placed at `${workspaceFolder}/credentials.json`, and have the following structure:
+```
+{
+    "username": "e4e_nas_user",
+    "password": "e4e_nas_password"
+}
+```
+
+If provided as an environment variable, the variable must be named `NAS_CREDS` and must have the following structure:
+```
+{"username":"e4e_nas_user","password":"e4e_nas_password"}
+```
+
+Any account used must have read access to the following share:
+- //e4e-nas.ucsd.edu/temp
+
+Execute `pytest` as follows:
+```
+python -m pytest pyha_tests
+```