adding configurable request timeouts

Author: Naor Livne

NebulaPythonSDK/sdk.py

@@ -5,7 +5,8 @@ class Nebula:
 
     # the nebula class init module serves as the login against the nebula API as it's the only shared thing among the
     # class functions
-    def __init__(self, username, password, host, port=80, protocol="http"):
+    def __init__(self, username, password, host, port=80, protocol="http", request_timeout=60):
+        self.request_timeout = request_timeout
         self.username = username
         self.password = password
         self.protocol = protocol
@@ -23,49 +24,49 @@ def create_app(self, app, config):
         url = self.host + "/api/apps/" + app
         payload = json.dumps(config)
         headers = self.headers
-        response = requests.request("POST", url, data=payload, headers=headers, timeout=300)
+        response = requests.request("POST", url, data=payload, headers=headers, timeout=self.request_timeout)
         return response
 
     # delete an existing nebula app, no confirmation required in SDK so be careful
     def delete_app(self, app):
         url = self.host + "/api/apps/" + app
         headers = self.headers
-        response = requests.request("DELETE", url, headers=headers, timeout=300)
+        response = requests.request("DELETE", url, headers=headers, timeout=self.request_timeout)
         return response
 
     # list all of the apps managed by nebula
     def list_apps(self):
         url = self.host + "/api/apps"
         headers = self.headers
-        response = requests.request("GET", url, headers=headers, timeout=300)
+        response = requests.request("GET", url, headers=headers, timeout=self.request_timeout)
         return response
 
     # list the config of a nebula app, only requires the app name
     def list_app_info(self, app):
         url = self.host + "/api/apps/" + app
         headers = self.headers
-        response = requests.request("GET", url, headers=headers, timeout=300)
+        response = requests.request("GET", url, headers=headers, timeout=self.request_timeout)
         return response
 
     # stop a nebula app, only requires the app name
     def stop_app(self, app):
         url = self.host + "/api/apps/" + app + "/stop"
         headers = self.headers
-        response = requests.request("POST", url, headers=headers, timeout=300)
+        response = requests.request("POST", url, headers=headers, timeout=self.request_timeout)
         return response
 
     # start a nebula app, only requires the app name
     def start_app(self, app):
         url = self.host + "/api/apps/" + app + "/start"
         headers = self.headers
-        response = requests.request("POST", url, headers=headers, timeout=300)
+        response = requests.request("POST", url, headers=headers, timeout=self.request_timeout)
         return response
 
     # restart a nebula app, only requires the app name
     def restart_app(self, app):
         url = self.host + "/api/apps/" + app + "/restart"
         headers = self.headers
-        response = requests.request("POST", url, headers=headers, timeout=300)
+        response = requests.request("POST", url, headers=headers, timeout=self.request_timeout)
         return response
 
     # update a nebula app, requires the app name and a dict of the config values you want to change, any combination of
@@ -74,19 +75,19 @@ def update_app(self, app, config):
         url = self.host + "/api/apps/" + app + "/update"
         payload = json.dumps(config)
         headers = self.headers
-        response = requests.request("PUT", url, data=payload, headers=headers, timeout=300)
+        response = requests.request("PUT", url, data=payload, headers=headers, timeout=self.request_timeout)
         return response
 
     # rolling restart an app, only requires the app name
     def roll_app(self, app):
         url = self.host + "/api/apps/" + app + "/roll"
         headers = self.headers
-        response = requests.request("POST", url, headers=headers, timeout=300)
+        response = requests.request("POST", url, headers=headers, timeout=self.request_timeout)
         return response
 
     # check that the contacted api is responding as expected
     def check_api(self):
         url = self.host + "/api/status"
         headers = self.headers
-        response = requests.request("GET", url, headers=headers, timeout=300)
+        response = requests.request("GET", url, headers=headers, timeout=self.request_timeout)
         return response

README.md

@@ -17,7 +17,7 @@ from NebulaPythonSDK import Nebula
 
 # Create API object.
 # port defaults to 80 and protocol defaults to http if not set
-connection = Nebula(username="your_nebula_user", password="your_nebula_pass", host="nebula.example.com", port=80, protocol="http")
+connection = Nebula(username="your_nebula_user", password="your_nebula_pass", host="nebula.example.com", port=80, protocol="http", request_timeout=60)
 
 # List apps
 app_list = connection.list_apps()