Bump Package Version

shaun-scale · shaun-scale · commit 3d33e19dc889 · 2020-09-03T17:50:36.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@
 /*.egg-info
 .tox
 .cache
+/.vscode/
diff --git a/build/lib/scaleapi/__init__.py b/build/lib/scaleapi/__init__.py
@@ -0,0 +1,188 @@
+import requests
+
+from .tasks import Task
+from .batches import Batch
+
+TASK_TYPES = [
+    'annotation',
+    'audiotranscription',
+    'categorization',
+    'comparison',
+    'cuboidannotation',
+    'datacollection',
+    'imageannotation',
+    'lineannotation',
+    'namedentityrecognition',
+    'pointannotation',
+    'polygonannotation',
+    'segmentannotation',
+    'transcription',
+    'videoannotation',
+    'videoboxannotation',
+    'videocuboidannotation'
+]
+SCALE_ENDPOINT = 'https://api.scale.com/v1/'
+DEFAULT_LIMIT = 100
+DEFAULT_OFFSET = 0
+
+
+class ScaleException(Exception):
+    def __init__(self, message, errcode):
+        super(ScaleException, self).__init__(
+            '<Response [{}]> {}'.format(errcode, message))
+        self.code = errcode
+
+
+class ScaleInvalidRequest(ScaleException, ValueError):
+    pass
+
+
+class Paginator(list):
+    def __init__(self, docs, total, limit, offset, has_more, next_token=None):
+        super(Paginator, self).__init__(docs)
+        self.docs = docs
+        self.total = total
+        self.limit = limit
+        self.offset = offset
+        self.has_more = has_more
+        self.next_token = next_token
+
+
+class Tasklist(Paginator):
+    pass
+
+
+class Batchlist(Paginator):
+    pass
+
+
+class ScaleClient(object):
+    def __init__(self, api_key):
+        self.api_key = api_key
+
+    def _getrequest(self, endpoint, params=None):
+        """Makes a get request to an endpoint.
+
+        If an error occurs, assumes that endpoint returns JSON as:
+            { 'status_code': XXX,
+              'error': 'I failed' }
+        """
+        params = params or {}
+        r = requests.get(SCALE_ENDPOINT + endpoint,
+                         headers={"Content-Type": "application/json"},
+                         auth=(self.api_key, ''), params=params)
+
+        if r.status_code == 200:
+            return r.json()
+        else:
+            try:
+                error = r.json()['error']
+            except ValueError:
+                error = r.text
+            if r.status_code == 400:
+                raise ScaleInvalidRequest(error, r.status_code)
+            else:
+                raise ScaleException(error, r.status_code)
+
+    def _postrequest(self, endpoint, payload=None):
+        """Makes a post request to an endpoint.
+
+        If an error occurs, assumes that endpoint returns JSON as:
+            { 'status_code': XXX,
+              'error': 'I failed' }
+        """
+        payload = payload or {}
+        r = requests.post(SCALE_ENDPOINT + endpoint, json=payload,
+                          headers={"Content-Type": "application/json"},
+                          auth=(self.api_key, ''))
+
+        if r.status_code == 200:
+            return r.json()
+        else:
+            try:
+                error = r.json()['error']
+            except ValueError:
+                error = r.text
+            if r.status_code == 400:
+                raise ScaleInvalidRequest(error, r.status_code)
+            else:
+                raise ScaleException(error, r.status_code)
+
+    def fetch_task(self, task_id):
+        """Fetches a task.
+
+        Returns the associated task.
+        """
+        return Task(self._getrequest('task/%s' % task_id), self)
+
+    def cancel_task(self, task_id):
+        """Cancels a task.
+
+        Returns the associated task.
+        Raises a ScaleException if it has already been canceled.
+        """
+        return Task(self._postrequest('task/%s/cancel' % task_id), self)
+
+    def tasks(self, **kwargs):
+        """Returns a list of your tasks.
+        Returns up to 100 at a time, to get more, use the next_token param passed back.
+
+        Note that offset is deprecated.
+
+        start/end_time are ISO8601 dates, the time range of tasks to fetch.
+        status can be 'completed', 'pending', or 'canceled'.
+        type is the task type.
+        limit is the max number of results to display per page,
+        next_token can be use to fetch the next page of tasks.
+        customer_review_status can be 'pending', 'fixed', 'accepted' or 'rejected'.
+        offset (deprecated) is the number of results to skip (for showing more pages).
+        """
+        allowed_kwargs = {'start_time', 'end_time', 'status', 'type', 'project',
+                          'batch', 'limit', 'offset', 'completed_before', 'completed_after',
+                          'next_token', 'customer_review_status', 'updated_before', 'updated_after'}
+        for key in kwargs:
+            if key not in allowed_kwargs:
+                raise ScaleInvalidRequest('Illegal parameter %s for ScaleClient.tasks()'
+                                          % key, None)
+        response = self._getrequest('tasks', params=kwargs)
+        docs = [Task(json, self) for json in response['docs']]
+        return Tasklist(docs, response['total'], response['limit'],
+                        response['offset'], response['has_more'], response.get('next_token'))
+
+    def create_task(self, task_type, **kwargs):
+        endpoint = 'task/' + task_type
+        taskdata = self._postrequest(endpoint, payload=kwargs)
+        return Task(taskdata, self)
+
+    def create_batch(self, project, batch_name, callback):
+        payload = dict(project=project, name=batch_name, callback=callback)
+        batchdata = self._postrequest('batches', payload)
+        return Batch(batchdata, self)
+
+    def get_batch(self, batch_name: str):
+        batchdata = self._getrequest('batches/%s' % batch_name)
+        return Batch(batchdata, self)
+
+    def list_batches(self, **kwargs):
+        allowed_kwargs = {'start_time', 'end_time', 'status', 'project',
+                          'batch', 'limit', 'offset', }
+        for key in kwargs:
+            if key not in allowed_kwargs:
+                raise ScaleInvalidRequest('Illegal parameter %s for ScaleClient.tasks()'
+                                          % key, None)
+        response = self._getrequest('tasks', params=kwargs)
+        docs = [Batch(doc, self) for doc in response['docs']]
+        return Batchlist(
+            docs, response['total'], response['limit'], response['offset'],
+            response['has_more'], response.get('next_token'),
+        )
+
+
+def _AddTaskTypeCreator(task_type):
+    def create_task_wrapper(self, **kwargs):
+        return self.create_task(task_type, **kwargs)
+    setattr(ScaleClient, 'create_' + task_type + '_task', create_task_wrapper)
+
+
+for taskType in TASK_TYPES:
+    _AddTaskTypeCreator(taskType)
diff --git a/build/lib/scaleapi/batches.py b/build/lib/scaleapi/batches.py
@@ -0,0 +1,26 @@
+class Batch(object):
+    def __init__(self, param_dict, client):
+        self.param_dict = param_dict
+        self.name = param_dict['name']
+        self.pending = None
+        self.completed = None
+        self.error = None
+        self.canceled = None
+        self.client = client
+
+    def __hash__(self):
+        return hash(self.name)
+
+    def __str__(self):
+        return 'Batch(name=%s)' % self.name
+
+    def __repr__(self):
+        return 'Batch(%s)' % self.param_dict
+
+    def finalize(self):
+        return self.client._postrequest("batches/%s/finalize" % self.name)
+
+    def get_status(self):
+        res = self.client._getrequest("batches/%s/status" % self.name)
+        for stat in ["pending", "completed", "error", "canceled"]:
+            setattr(self, stat, res.get(stat, 0))
diff --git a/build/lib/scaleapi/tasks.py b/build/lib/scaleapi/tasks.py
@@ -0,0 +1,30 @@
+class Task(object):
+    """Task class, containing task information."""
+
+    def __init__(self, param_dict, client):
+        self.client = client
+        self.param_dict = param_dict
+        self.id = param_dict['task_id']
+
+    def __getattr__(self, name):
+        if name in self.param_dict:
+            return self.param_dict[name]
+        if name in self.params:
+            return self.params[name]
+        raise AttributeError("'%s' object has no attribute %s"
+                             % (type(self).__name__, name))
+
+    def __hash__(self):
+        return hash(self.id)
+
+    def __str__(self):
+        return 'Task(id=%s)' % self.id
+
+    def __repr__(self):
+        return 'Task(%s)' % self.param_dict
+
+    def refresh(self):
+        self.param_dict = self.client._getrequest('task/%s' % self.id)
+
+    def cancel(self):
+        self.client.cancel_task(self.id)
diff --git a/pypi_update_guide.md b/pypi_update_guide.md
@@ -0,0 +1,51 @@
+_Creating and deploying a new package version is easy_
+
+### Prerequisites
+
+1. Ensure you're on the latest master
+
+2. Ensure you have a PyPI account created and are added as a Collaborator
+
+### Deployment Steps:
+
+**Step 0: Critical - Bump Project Version**
+
+In `setup.py`, you need to specify a new project version.
+
+We use [semantic versioning](https://packaging.python.org/guides/distributing-packages-using-setuptools/#semantic-versioning-preferred). If you are adding a meaningful feature, bump the minor version. If you are fixing a bug, bump the incremental version.
+
+**Step 1: Remove Previous Versions**
+
+Clear out any previously packaged files in the `dist` folder
+
+**Step 2: Create a Source Distribution**
+
+```
+python3 setup.py sdist
+```
+
+**Step 3: Create `wheel`**
+
+You should also create a wheel for your project. A wheel is a built package that can be installed without needing to go through the “build” process. Installing wheels is substantially faster for the end user than installing from a source distribution
+
+```
+python3 setup.py bdist_wheel
+```
+
+**Step 4: Install Twine**
+
+Twine is what is used to manage PyPI pacakges
+
+```
+pip3 install twine
+```
+
+**Step 5: Upload distribution to PyPI**
+
+```
+twine upload dist/*
+```
+
+**Step 6: Check out the PyPI page to ensure all looks good**
+
+[https://pypi.org/project/scaleapi/](https://pypi.org/project/scaleapi/)
diff --git a/scaleapi/__init__.py b/scaleapi/__init__.py
@@ -1,4 +1,3 @@
-from collections import namedtuple
 import requests
 
 from .tasks import Task
@@ -26,9 +25,11 @@
 DEFAULT_LIMIT = 100
 DEFAULT_OFFSET = 0
 
+
 class ScaleException(Exception):
     def __init__(self, message, errcode):
-        super(ScaleException, self).__init__('<Response [{}]> {}'.format(errcode, message))
+        super(ScaleException, self).__init__(
+            '<Response [{}]> {}'.format(errcode, message))
         self.code = errcode
 
 
@@ -147,6 +148,7 @@ def tasks(self, **kwargs):
         docs = [Task(json, self) for json in response['docs']]
         return Tasklist(docs, response['total'], response['limit'],
                         response['offset'], response['has_more'], response.get('next_token'))
+
     def create_task(self, task_type, **kwargs):
         endpoint = 'task/' + task_type
         taskdata = self._postrequest(endpoint, payload=kwargs)
@@ -162,8 +164,8 @@ def get_batch(self, batch_name: str):
         return Batch(batchdata, self)
 
     def list_batches(self, **kwargs):
-        allowed_kwargs = { 'start_time', 'end_time', 'status', 'project',
-                           'batch', 'limit', 'offset', }
+        allowed_kwargs = {'start_time', 'end_time', 'status', 'project',
+                          'batch', 'limit', 'offset', }
         for key in kwargs:
             if key not in allowed_kwargs:
                 raise ScaleInvalidRequest('Illegal parameter %s for ScaleClient.tasks()'
@@ -181,5 +183,6 @@ def create_task_wrapper(self, **kwargs):
         return self.create_task(task_type, **kwargs)
     setattr(ScaleClient, 'create_' + task_type + '_task', create_task_wrapper)
 
+
 for taskType in TASK_TYPES:
     _AddTaskTypeCreator(taskType)
diff --git a/scaleapi/tasks.py b/scaleapi/tasks.py
@@ -1,5 +1,6 @@
 class Task(object):
     """Task class, containing task information."""
+
     def __init__(self, param_dict, client):
         self.client = client
         self.param_dict = param_dict
diff --git a/setup.py b/setup.py
