split upload photo into upload_job_photo and upload_profile_photo. updated docs

Author: 2lives

README.md

@@ -1,9 +1,5 @@
 # Skylab Studio Python Client
 
-[![CircleCI](https://circleci.com/gh/skylab-tech/studio_client_python.svg?style=svg)](https://circleci.com/gh/skylab-tech/studio_client_python)
-[![Maintainability](https://api.codeclimate.com/v1/badges/6e3316f60d72a9ca9276/maintainability)](https://codeclimate.com/github/skylab-tech/studio_client_python/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/6e3316f60d72a9ca9276/test_coverage)](https://codeclimate.com/github/skylab-tech/studio_client_python/test_coverage)
-
 SkylabTech Studio Python client.
 
 [studio.skylabtech.ai](https://studio.skylabtech.ai)
@@ -18,6 +14,36 @@ SkylabTech Studio Python client.
 $ pip install skylab_studio
 ```
 
+## Example usage
+
+```python
+# CREATE PROFILE
+payload = {
+  "name": "profile name",
+}
+
+api.create_profile(payload=payload)
+
+# CREATE JOB
+payload={
+  "name": "job name",
+  "profile_id": profile_id
+}
+
+job = api.create_job(payload)
+
+# UPLOAD JOB PHOTO(S)
+filePath = "/path/to/photo"
+api.upload_job_photo(filePath, job.id)
+
+# QUEUE JOB
+payload = { "callback_url" = "YOUR_CALLBACK_ENDPOINT" }
+api.queue_job(job.id, payload)
+
+# NOTE: Once the job is queued, it will get processed then complete
+# We will send a response to the specified callback_url with the output photo download urls
+```
+
 ## Usage
 
 For all examples, assume:
@@ -148,26 +174,20 @@ api.list_photos()
 api.get_photo(photo_id)
 ```
 
-#### Upload photo
+#### Upload job photo
 
 This function handles validating a photo, creating a photo object and uploading it to your job/profile's s3 bucket. If the bucket upload process fails, it retries 3 times and if failures persist, the photo object is deleted.
 
 ```python
-upload_photo(photo_path, model, model_id)
+api.upload_job_photo(photo_path, job_id)
 ```
 
-model can either be 'job' or 'profile'
-
-model_id is the jobs/profiles respective id
-
-```python
-api.upload_photo('/path/to/photo', 'job', job_id)
-```
+#### Upload profile photo
 
-OR
+This function handles validating a background photo for a profile. Note: enable_extract and replace_background (profile attributes) MUST be true in order to create background photos. Follows the same upload process as upload_job_photo.
 
 ```python
-api.upload_photo('/path/to/photo', 'profile', profile_id)
+api.upload_profile_photo(photo_path, profile_id)
 ```
 
 `Returns: { photo: { photo_object }, upload_response: bucket_upload_response_status }`

skylab_studio/__init__.py

@@ -271,8 +271,14 @@ def calculate_md5(self, file_path):
             for chunk in iter(lambda: file.read(4096), b""):
                 md5_hash.update(chunk)
         return md5_hash.hexdigest()
+    
+    def upload_job_photo(self, photo_path, id):
+        return self._upload_photo(photo_path, id, 'job')
 
-    def upload_photo(self, photo_path, model, id):
+    def upload_profile_photo(self, photo_path, id):
+        return self._upload_photo(photo_path, id, 'profile')
+
+    def _upload_photo(self, photo_path, id, model='job'):
         res = {}
         valid_exts_to_check = ('.jpg', '.jpeg', '.png', '.webp')
         if not photo_path.lower().endswith(valid_exts_to_check):
@@ -294,19 +300,18 @@ def upload_photo(self, photo_path, model, id):
         photo_data = { f"{model}_id": id, "name": photo_name, "use_cache_upload": False }
 
         if model == 'job':
-            job_type = self.get_job(id).json()['type']
+            job_type = self.get_job(id)['type']
 
             if job_type == 'regular':
                 headers = { 'X-Amz-Tagging': 'job=photo&api=true' }
 
         # Ask studio to create the photo record
         photo_resp = self._create_photo(photo_data)
+        if not photo_resp:
+            raise Exception('Unable to create the photo object, if creating profile photo, ensure enable_extract and replace_background is set to: True')
 
-        if photo_resp.status_code != 201:
-            raise Exception('Unable to create the photo object')
-
-        photo_id = photo_resp.json()['id']
-        res['photo'] = photo_resp.json()
+        photo_id = photo_resp['id']
+        res['photo'] = photo_resp
 
         # md5 = self.calculate_md5(photo_path)
         b64md5 = base64.b64encode(bytes.fromhex(md5hash)).decode('utf-8')
@@ -318,22 +323,22 @@ def upload_photo(self, photo_path, model, id):
 
         # Ask studio for a presigned url
         upload_url_resp = self._get_upload_url(payload=payload)
-        upload_url = upload_url_resp.json()['url']
+        upload_url = upload_url_resp['url']
 
         # PUT request to presigned url with image data
         headers["Content-MD5"] = b64md5
 
         try:
           upload_photo_resp = requests.put(upload_url, data, headers=headers)
 
-          if upload_photo_resp.status_code != 200:
+          if not upload_photo_resp:
             print('First upload attempt failed, retrying...')
             retry = 0
             # retry upload
             while retry < 3:
                 upload_photo_resp = requests.put(upload_url, data, headers=headers)
 
-                if upload_photo_resp.status_code == 200:
+                if upload_photo_resp:
                     break  # Upload was successful, exit the loop
                 elif retry == 2:  # Check if retry count is 2 (0-based indexing)
                     raise Exception('Unable to upload to the bucket after retrying.')

test/test_api.py

@@ -45,7 +45,7 @@ def test_api_debug():
 def test_list_jobs(api):
     """ Test list jobs endpoint. """
     result = api.list_jobs()
-    assert result.status_code == 200
+    assert result is not None
 
 def test_create_job(api):
     """ Test list jobs endpoint. """
@@ -58,16 +58,16 @@ def test_create_job(api):
     result = api.create_job(payload=job_payload)
     global job_id
 
-    job_id = result.json()['id']
+    job_id = result['id']
     assert job_id is not None
-    assert result.status_code == 201
+    assert result is not None
 
 def test_get_job(api):
     global job_id
     assert job_id is not 0
 
     result = api.get_job(job_id)
-    assert result.status_code == 200
+    assert result is not None
 
 def test_update_job(api):
     global job_id
@@ -76,7 +76,7 @@ def test_update_job(api):
         'name': new_job_name
     }
     result = api.update_job(job_id, payload=payload)
-    assert result.status_code == 200
+    assert result is not None
 
 def test_cancel_job(api):
     job_name = str(uuid.uuid4())
@@ -86,9 +86,10 @@ def test_cancel_job(api):
     }
 
     result = api.create_job(payload=job_payload)
-    job_id = result.json()['id']
+
+    job_id = result['id']
     job_cancel_result = api.cancel_job(job_id)
-    assert job_cancel_result.status_code == 200
+    assert job_cancel_result is not None
 
 def test_delete_job(api):
     job_name = str(uuid.uuid4())
@@ -98,62 +99,71 @@ def test_delete_job(api):
     }
 
     result = api.create_job(payload=job_payload)
-    job_id = result.json()['id']
+    job_id = result['id']
 
     result = api.delete_job(job_id)
-    assert result.status_code == 200
+    assert result is not None
 
 
 def test_list_profiles(api):
     result = api.list_profiles()
-    assert result.status_code == 200
+    assert result is not None
 
 def test_create_profile(api):
     global profile_id
     profile_name = str(uuid.uuid4())
     payload = {
         'name': profile_name,
-        'enable_crop': False
+        'enable_crop': False,
+        'enable_extract': True,
+        'replace_background': True
     }
     result = api.create_profile(payload=payload)
-    profile_id = result.json()['id']
+    profile_id = result['id']
 
     assert profile_id is not None
-    assert result.status_code == 201
+    assert result is not None
 
-def test_upload_photo(api, pytestconfig):
+def test_upload_job_photo(api, pytestconfig):
     global job_id
     global photo_id
 
-    result = api.upload_photo(f"{pytestconfig.rootdir}/test/test-portrait-1.JPG", 'job', job_id)
+    result = api.upload_job_photo(f"{pytestconfig.rootdir}/test/test-portrait-1.JPG", job_id)
 
-    assert result['photo']['id'] is not None
     photo_id = result['photo']['id']
     assert result['upload_response'] == 200
 
+def test_upload_profile_photo(api, pytestconfig):
+    global profile_id
+
+    result = api.upload_profile_photo(f"{pytestconfig.rootdir}/test/test-portrait-1.JPG", profile_id)
+
+    assert result['upload_response'] == 200
+
+
 def test_get_profile(api):
     global profile_id
     result = api.get_profile(profile_id)
-    assert result.status_code == 200
+    assert result is not None
 
 def test_update_profile(api):
     global profile_id
     payload = {
         'description': 'a description!'
     }
     result = api.update_profile(profile_id, payload=payload)
-    assert result.status_code == 200
+    assert result is not None
 
 def test_list_photos(api):
     result = api.list_photos()
-    assert result.status_code == 200
+    assert result is not None
 
 def test_get_photo(api):
     global photo_id
     result = api.get_photo(photo_id)
-    assert result.status_code == 200
+    assert result is not None
 
 def test_delete_photo(api):
     global photo_id
     result = api.delete_photo(photo_id)
-    assert result.status_code == 200
+    assert result is not None