Ignore all config files except examples and allow configuratio n.yaml default

.gitignore

@@ -111,12 +111,13 @@ venv.bak/
 credentials.json
 
 # API Gateway credentials (if instructions in README are followed)
-api_gateway_credentials.json
-api_gateway_credentials.yaml
-api_gateway_credentials.yml
+*.json
+!api_gateway_credentials-example.json
 
-# Local configuration
-gsuitesync.yaml
+# Potential local configuration files
+*.yaml
+*.yml
+!configuration-example.yaml
 
 .vscode/
 cache/

README.md

@@ -173,7 +173,8 @@ in the domain **subject to the listed scopes**.
 ## Preparing API Gateway credentials
 
 The `api_gateway` section in the configuration file specifies where the
-credentials for accessing API Gateway can be found. These credentials must be
+credentials for accessing API Gateway can be found; see the
+[example file](api_gateway_credentials-example.json). These credentials must be
 supplied as a file in YAML/JSON format with values for the keys `base_url`,
 `client_id` and `client_secret`. The key and secret can be found on the
 [Apigee apps page](https://apigee.google.com/organizations/api-prod-a3dc87f7/apps)

api_gateway_credentials-example.json

+{
+    "client_id": "API Gateway Client ID",
+    "client_secret": "API Gateway Client Secret",
+    "base_url": "https://api.apps.cam.ac.uk/lookup/v1"
+}
\ No newline at end of file

gsuitesync/config/utils.py

@@ -27,6 +27,7 @@ def load_configuration(location=None):
             paths = []
         paths.extend([
             os.path.join(os.getcwd(), 'gsuitesync.yaml'),
+            os.path.join(os.getcwd(), 'configuration.yaml'),
             os.path.expanduser('~/.gsuitesync/configuration.yaml'),
             '/etc/gsuitesync/configuration.yaml'
         ])