From 6822f3a703bc0e54808af63656304794eb0d900d Mon Sep 17 00:00:00 2001
From: David Shafer <dshafer@internet2.edu>
Date: Tue, 12 Apr 2022 16:10:36 -0500
Subject: [PATCH] Update usage instructions

---
 README.md            | 30 +++++++++++++-----------------
 variables.py.example | 30 ------------------------------
 2 files changed, 13 insertions(+), 47 deletions(-)
 delete mode 100644 variables.py.example

diff --git a/README.md b/README.md
index bbb5d30..151d3bc 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,6 @@ See also:
 * [Metadata Query Protocol](https://tools.ietf.org/html/draft-young-md-query-09)
 * [SAML Profile for the Metadata Query Protocol](https://tools.ietf.org/html/draft-young-md-query-saml-09)
 
-
 ## Getting Started
 
 1. Clone this repository:
@@ -17,39 +16,36 @@ See also:
     git clone https://github.internet2.edu/internet2/md-query-saml-uat.git
     ```
 
-2. Copy `variables.py.example` to `variables.py`:
+2. Create and activate a new Python virtual environment:
 
     ```sh
-    cp variables.py.example variables.py
+    python3 -m venv .venv && source .venv/bin/activate
     ```
 
-3. Edit `variables.py` for your environment.
-
-4. Run the test suite:
+3. Install dependencies:
 
     ```sh
-    robot --noncritical optional .
+    pip install -r requirements.txt
     ```
 
-## Usage
+4. Run all tests in the current directory, skipping failures in any tests tagged as "optional":
 
-Run all test cases in the current directory:
+    ```sh
+    robot --skiponfailure optional .
+    ```
 
-```sh
-robot .
-```
+## Usage
 
-Treat any test cases tagged with `optional` as noncritical:
+Read variables from another file:
 
 ```sh
-robot --skiponfailure optional .
+robot --variablefile dev-variables.py .
 ```
 
-Additionally skip long-running test cases (those that download and parse all
-entities):
+Skip downloading and parsing the complete aggregate:
 
 ```sh
-robot --skiponfailure optional --exclude aggregate .
+robot --exclude aggregate .
 ```
 
 ## Contributing
diff --git a/variables.py.example b/variables.py.example
deleted file mode 100644
index 0cd303f..0000000
--- a/variables.py.example
+++ /dev/null
@@ -1,30 +0,0 @@
-# Base Metadata Query server URL (without trailing "/")
-# Example: https://example.org/md
-BASE_URL = "http://md.sandbox.ti.internet2.edu"
-
-# Any known existing entityID
-ENTITY_ID = "https://fm.incommon.org/sp"
-
-# Percent-encoded form of ENTITY_ID above
-ENTITY_ID_ENCODED = "https:%2F%2Ffm.incommon.org%2Fsp"
-
-# Percent-encoded form of ENTITY_ID above using uppercase percent-encoding
-ENTITY_ID_ENCODED_UPPERCASE = "https:%2F%2Ffm.incommon.org%2Fsp"
-
-# Percent-encoded form of ENTITY_ID above using lowercase percent-encoding
-ENTITY_ID_ENCODED_LOWERCASE = "https:%2f%2ffm.incommon.org%2fsp"
-
-# SHA-1 transformed form of ENTITY_ID above
-ENTITY_ID_SHA1 = "20f0fe93f679ac8a2ddcf0822ecdec007c56546f"
-
-# InCommon URL-style entityID
-INC_ENTITY_ID_URL = "https://fm.incommon.org/sp"
-
-# Percent-encoded form of INC_ENTITY_ID_URL above
-INC_ENTITY_ID_URL_ENCODED = "https:%2F%2Ffm.incommon.org%2Fsp"
-
-# InCommon URN-style entityID
-INC_ENTITY_ID_URN = "urn:mace:incommon:internet2.edu"
-
-# InCommon collection of all IdPs
-INC_ALL_IDPS = "idps/all"