Add methods for use as a library

README.md

@@ -10,10 +10,23 @@ or even to be authenticated with Google Cloud SDK.
 
 Python 3.7+
 
-## Usage
+## Installation
 
-```
 pip3 install find-gcp-keys
 
+## Usage
+
+As a command-line utility:
+
+```
 find_gcp_keys <dir_path>
 ```
+
+As a library:
+
+```
+import find_gcp_keys
+...
+for path in find_gcp_keys.search(dir_path):
+  print(path)
+```

find_gcp_keys/__init__.py

@@ -0,0 +1,5 @@
+"""
+Finds and reports valid Google Service Account keys on your filesystem
+"""
+
+from find_gcp_keys.__main__ import find_key_paths, is_valid_key, search

find_gcp_keys/__main__.py

@@ -51,15 +51,21 @@ def is_valid_key(file_path: str):
         return False
 
 
+def search(dir_path: str):
+    """ Recursively walks `dir_path` and finds valid GCP SA keys """
+    for path in find_key_paths(dir_path):
+        if is_valid_key(path):
+            yield path
+
+
 def main():
     """ Main entrypoint """
     args = parse_args()
 
     found = False
-    for path in find_key_paths(args.dir_path):
-        if is_valid_key(path):
-            print(path, file=sys.stderr)
-            found = True
+    for path in search(args.dir_path):
+        print(path, file=sys.stderr)
+        found = True
 
     if found:
         sys.exit(1)