Docstring for Profile Keygen Util

nathanielvarona · May 4, 2024 · 873387b · 873387b
1 parent 9df6cf7
commit 873387b
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/pritunl_api/utils/keygen.py b/pritunl_api/utils/keygen.py
@@ -1,6 +1,17 @@
 from urllib.parse import urlparse
 
 def profile_key(pritunl, org_id, usr_id):
+    """
+    Generate URLs for a profile key in Pritunl.
+
+    Args:
+        pritunl (object): Pritunl API client
+        org_id (str): Organization ID
+        usr_id (str): User ID
+
+    Returns:
+        tuple: (key_uri_url, key_view_url) or (None, None) if no key is found
+    """
     key = pritunl.key.get(org_id=org_id, usr_id=usr_id)
     if key:
         key_uri_url = urlparse(pritunl.BASE_URL)._replace(scheme='pritunl').geturl() + key['uri_url']