Merge pull request #11 from arnaudlimbourg/update-to-python-3-syntax

Update to python 3 syntax and use Github actions

Author: kvz

.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  python:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.6", "3.7", "3.8", "3.9"]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+
+      - name: Install Dependencies
+        run: pip install -e .[test]
+
+      - name: Test with pytest
+        run: |
+          pytest --cov=transloadit tests

.travis.yml

@@ -1,3 +1,5 @@
+* Drop Python versions before 3.6 as they are unsupported
+* Update code to Python 3 syntax
 ### 0.1.12/ 2020-14-12 ###
 
 * Send `transloadit-client` header along with requests

CHANGELOG.md

@@ -10,6 +10,8 @@ A **Python** Integration for [Transloadit](https://transloadit.com)'s file uploa
 
 This is a **Python** SDK to make it easy to talk to the [Transloadit](https://transloadit.com) REST API.
 
+Only Python 3.6+ versions are supported.
+
 ## Install
 
 ```bash

README.md

@@ -1 +1 @@
-__version__ = '0.1.12'
+__version__ = "0.1.12"

transloadit/__init__.py

@@ -25,8 +25,9 @@ class Assembly(optionbuilder.OptionBuilder):
             Params to send along with the assembly. Please see
             https://transloadit.com/docs/api-docs/#21-create-a-new-assembly for available options.
     """
+
     def __init__(self, transloadit, files=None, options=None):
-        super(Assembly, self).__init__(options)
+        super().__init__(options)
         self.transloadit = transloadit
         self.files = files or {}
 
@@ -45,14 +46,14 @@ def add_file(self, file_stream, field_name=None):
         self.files[field_name] = file_stream
 
     def _get_field_name(self):
-        name = 'file'
+        name = "file"
         if name not in self.files:
             return name
 
         counter = 1
-        while '{}_{}'.format(name, counter) in self.files:
+        while f"{name}_{counter}" in self.files:
             counter += 1
-        return '{}_{}'.format(name, counter)
+        return f"{name}_{counter}"
 
     def remove_file(self, field_name):
         """
@@ -65,14 +66,16 @@ def remove_file(self, field_name):
 
     def _do_tus_upload(self, assembly_url, tus_url, retries):
         tus_client = tus.TusClient(tus_url)
-        metadata = {'assembly_url': assembly_url}
+        metadata = {"assembly_url": assembly_url}
         for key in self.files:
-            metadata['fieldname'] = key
-            metadata['filename'] = os.path.basename(self.files[key].name)
-            tus_client.uploader(file_stream=self.files[key],
-                                chunk_size=5*1024*1024,
-                                metadata=metadata,
-                                retries=retries).upload()
+            metadata["fieldname"] = key
+            metadata["filename"] = os.path.basename(self.files[key].name)
+            tus_client.uploader(
+                file_stream=self.files[key],
+                chunk_size=5 * 1024 * 1024,
+                metadata=metadata,
+                retries=retries,
+            ).upload()
 
     def create(self, wait=False, resumable=True, retries=3):
         """
@@ -89,35 +92,40 @@ def create(self, wait=False, resumable=True, retries=3):
         """
         data = self.get_options()
         if resumable:
-            extra_data = {'tus_num_expected_upload_files': len(self.files)}
+            extra_data = {"tus_num_expected_upload_files": len(self.files)}
             response = self.transloadit.request.post(
-                '/assemblies', extra_data=extra_data, data=data)
-            self._do_tus_upload(response.data.get('assembly_ssl_url'),
-                                response.data.get('tus_url'),
-                                retries)
+                "/assemblies", extra_data=extra_data, data=data
+            )
+            self._do_tus_upload(
+                response.data.get("assembly_ssl_url"),
+                response.data.get("tus_url"),
+                retries,
+            )
         else:
             response = self.transloadit.request.post(
-                '/assemblies', data=data, files=self.files)
+                "/assemblies", data=data, files=self.files
+            )
 
         if wait:
             while not self._assembly_finished(response):
                 response = self.transloadit.get_assembly(
-                    assembly_url=response.data.get('assembly_ssl_url'))
+                    assembly_url=response.data.get("assembly_ssl_url")
+                )
 
         if self._rate_limit_reached(response) and retries:
             # wait till rate limit is expired
-            sleep(response.data.get('info', {}).get('retryIn', 0))
+            sleep(response.data.get("info", {}).get("retryIn", 0))
             self.create(wait, resumable, retries - 1)
 
         return response
 
     def _assembly_finished(self, response):
-        status = response.data.get('ok')
-        is_aborted = status == 'REQUEST_ABORTED'
-        is_canceled = status == 'ASSEMBLY_CANCELED'
-        is_completed = status == 'ASSEMBLY_COMPLETED'
-        is_failed = response.data.get('error') is not None
+        status = response.data.get("ok")
+        is_aborted = status == "REQUEST_ABORTED"
+        is_canceled = status == "ASSEMBLY_CANCELED"
+        is_completed = status == "ASSEMBLY_COMPLETED"
+        is_failed = response.data.get("error") is not None
         return is_aborted or is_canceled or is_completed or is_failed
 
     def _rate_limit_reached(self, response):
-        return response.data.get('error') == 'RATE_LIMIT_REACHED'
+        return response.data.get("error") == "RATE_LIMIT_REACHED"

transloadit/assembly.py

@@ -3,7 +3,7 @@
 from . import template
 
 
-class Transloadit(object):
+class Transloadit:
     """
     This class serves as a client interface to the Transloadit API.
 
@@ -24,9 +24,16 @@ class Transloadit(object):
             How long in seconds for which a Transloadit request should be valid. Defaults to 300
             if not specified.
     """
-    def __init__(self, auth_key, auth_secret, service='https://api2.transloadit.com', duration=300):
-        if not service.startswith(('http://', 'https://')):
-            service = 'https://' + service
+
+    def __init__(
+        self,
+        auth_key,
+        auth_secret,
+        service="https://api2.transloadit.com",
+        duration=300,
+    ):
+        if not service.startswith(("http://", "https://")):
+            service = "https://" + service
 
         self.service = service
         self.auth_key = auth_key
@@ -49,13 +56,13 @@ def get_assembly(self, assembly_id=None, assembly_url=None):
         :Args:
             - assembly_id (Optional[str])
             - assembly_url (Optional[str])
-        
+
         Return an instance of <transloadit.response.Response>
         """
         if not (assembly_id or assembly_url):
             raise ValueError("Either 'assembly_id' or 'assembly_url' cannot be None.")
 
-        url = assembly_url if assembly_url else '/assemblies/{}'.format(assembly_id)
+        url = assembly_url if assembly_url else f"/assemblies/{assembly_id}"
         return self.request.get(url)
 
     def list_assemblies(self, params=None):
@@ -66,10 +73,10 @@ def list_assemblies(self, params=None):
             - options (Optional[dict]):
                 params to send along with the request. Please see
                 https://transloadit.com/docs/api-docs/#25-retrieve-assembly-list for available options.
-        
+
         Return an instance of <transloadit.response.Response>
         """
-        return self.request.get('/assemblies', params=params)
+        return self.request.get("/assemblies", params=params)
 
     def cancel_assembly(self, assembly_id=None, assembly_url=None):
         """
@@ -79,13 +86,13 @@ def cancel_assembly(self, assembly_id=None, assembly_url=None):
         :Args:
             - assembly_id (Optional[str])
             - assembly_url (Optional[str])
-        
+
         Return an instance of <transloadit.response.Response>
         """
         if not (assembly_id or assembly_url):
             raise ValueError("Either 'assembly_id' or 'assembly_url' cannot be None.")
 
-        url = assembly_url if assembly_url else '/assemblies/{}'.format(assembly_id)
+        url = assembly_url if assembly_url else f"/assemblies/{assembly_id}"
         return self.request.delete(url)
 
     def get_template(self, template_id):
@@ -94,10 +101,10 @@ def get_template(self, template_id):
 
         :Args:
             - template_id (str)
-        
+
         Return an instance of <transloadit.response.Response>
         """
-        return self.request.get('/templates/{}'.format(template_id))
+        return self.request.get(f"/templates/{template_id}")
 
     def list_templates(self, params=None):
         """
@@ -107,10 +114,10 @@ def list_templates(self, params=None):
             - options (Optional[dict]):
                 params to send along with the request. Please see
                 https://transloadit.com/docs/api-docs/#45-retrieve-template-list for available options.
-        
+
         Return an instance of <transloadit.response.Response>
         """
-        return self.request.get('/templates', params=params)
+        return self.request.get("/templates", params=params)
 
     def new_template(self, name, params=None):
         """
@@ -132,7 +139,7 @@ def update_template(self, template_id, data):
 
         Return an instance of <transloadit.response.Response>
         """
-        return self.request.put('/templates/{}'.format(template_id), data=data)
+        return self.request.put(f"/templates/{template_id}", data=data)
 
     def delete_template(self, template_id):
         """
@@ -143,7 +150,7 @@ def delete_template(self, template_id):
 
         Return an instance of <transloadit.response.Response>
         """
-        return self.request.delete('/templates/{}'.format(template_id))
+        return self.request.delete(f"/templates/{template_id}")
 
     def get_bill(self, month, year):
         """
@@ -152,7 +159,7 @@ def get_bill(self, month, year):
         :Args:
             - month (int): e.g 1 for January
             - year (int)
-        
+
         Return an instance of <transloadit.response.Response>
         """
-        return self.request.get('/bill/{}-{:02d}'.format(year, month))
+        return self.request.get(f"/bill/{year}-{month:02d}")

transloadit/client.py

@@ -1,7 +1,7 @@
 import copy
 
 
-class OptionBuilder(object):
+class OptionBuilder:
     """
     Object representation of a new Assembly to be created.
 
@@ -17,8 +17,9 @@ class OptionBuilder(object):
             params to send along with the assembly. Please see
             https://transloadit.com/docs/api-docs/#21-create-a-new-assembly for available options.
     """
+
     def __init__(self, options=None):
-        super(OptionBuilder, self).__init__()
+        super().__init__()
         self.options = options or {}
         self.steps = {}
 
@@ -31,7 +32,7 @@ def add_step(self, name, robot, options):
             - robot (str): The name of the robot for the step
             - options (dict): The options to apply to the step
         """
-        options['robot'] = robot
+        options["robot"] = robot
         self.steps[name] = options
 
     def remove_step(self, name):
@@ -45,8 +46,8 @@ def remove_step(self, name):
 
     def get_options(self):
         """
-        Return the Assembly/Template options in Transloadit, ready format. 
+        Return the Assembly/Template options in Transloadit, ready format.
         """
         options = copy.deepcopy(self.options)
-        options['steps'] = self.steps
+        options["steps"] = self.steps
         return options