Update Readme

Updated docstrings

Prevent pre-allocation for download resources

Improve doc strings and add arbitrary range request

Parameterize the download directory for integration test

Adds speedtest.net powered bandwidth check

Adds download benchmark script

Adds download progress UI

Auto stash before rebase of "jh/speed-test"
Refactor transport layer and add telemetry and logging

WIP Dockerfile

Update python version matrix for CI

WIP add telemetry

Dockerfile for CDN perf testing

add missing dep in setup.py

Missing comma :face-palm:

Fix name of the segment python package

Add additional missing packages

Add missing comma

Adjust status bar position

Continued telemetry work

Author: jhodges10

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python.formatting.provider": "black"
+}

Dockerfile

@@ -0,0 +1,34 @@
+FROM python:3.8.6-slim-buster as deps
+# Set work directory
+WORKDIR /home/speedtest
+
+# Copy files
+COPY Pipfile .
+COPY Pipfile.lock .
+
+# Install pipenv
+RUN pip install pipenv
+
+FROM deps as installer
+# Set work directory
+WORKDIR  /home/speedtest
+
+# Install deps
+RUN pipenv install --system --deploy --ignore-pipfile
+
+# Copy over the other pieces
+COPY frameioclient frameioclient
+COPY setup.py .
+COPY README.md .
+
+# Install the local frameioclient
+RUN pipenv install -e . --skip-lock
+
+# Copy over scripts and tests
+COPY scripts scripts
+COPY tests tests
+
+ENV SEGMENT_WRITE_KEY=
+
+FROM installer as runtime
+ENTRYPOINT [ "pipenv", "run", "python", "scripts/benchmark/download.py" ]

Makefile

@@ -17,4 +17,16 @@ clean:
 	find . -name "*.pyc" -exec rm -f {} \;
 
 test:
-	cd tests && pipenv run python integration.py
+	cd tests && pipenv run python integration.py
+
+package:
+	pipenv run python3 setup.py sdist bdist_wheel
+
+build-docker:
+	docker build . -t benchmark
+
+run-benchmark:
+	docker run -it -e $1 benchmark
+
+format:
+	black frameioclient

examples/download_asset.py

@@ -1 +1,3 @@
-from .client import FrameioClient
+from .lib import *
+from .services import *
+from .client import FrameioClient

frameioclient/__init__.py

@@ -1,80 +1,25 @@
-import sys
-import requests
-from requests.adapters import HTTPAdapter
-from requests.packages.urllib3.util.retry import Retry
-
 from .lib import (
+  Utils,
   APIClient,
+  AWSClient,
   Telemetry,
   ClientVersion,
-  PaginatedResponse,
-  Utils,
   ClientVersion,
-  FrameioDownloader,
-  PresentationException
+  FrameioDownloader
 )
 
 class FrameioClient(APIClient, object):
-  def __init__(self, token, host='https://api.frame.io'):
+  def __init__(self, token, host):
     super().__init__(token, host)
 
-    self.adapter = HTTPAdapter(max_retries=self.retry_strategy)
-    self.session = requests.Session()
-    self.session.mount("https://", self.adapter)
-
-  def _api_call(self, method, endpoint, payload={}, limit=None):
-    url = '{}/v2{}'.format(self.host, endpoint)
-
-    r = self.session.request(
-      method,
-      url,
-      json=payload,
-      headers=self.headers,
-    )
-
-    if r.ok:
-      if r.headers.get('page-number'):
-        if int(r.headers.get('total-pages')) > 1:
-          return PaginatedResponse(
-            results=r.json(),
-            limit=limit,
-            page_size=r.headers['per-page'],
-            total_pages=r.headers['total-pages'],
-            total=r.headers['total'],
-            endpoint=endpoint,
-            method=method,
-            payload=payload,
-            client=self
-          )
-      if isinstance(r.json(), list):
-        return r.json()[:limit]
-      return r.json()
-
-    if r.status_code == 422 and "presentation" in endpoint:
-      raise PresentationException
-
-    return r.raise_for_status()
-
-  def get_specific_page(self, method, endpoint, payload, page):
-    """
-    Gets a specific page for that endpoint, used by Pagination Class
-
-    :Args:
-      method (string): 'get', 'post'
-      endpoint (string): endpoint ('/accounts/<ACCOUNT_ID>/teams')
-      payload (dict): Request payload
-      page (int): What page to get
-    """
-    if method == 'get':
-      endpoint = '{}?page={}'.format(endpoint, page)
-      return self._api_call(method, endpoint)
-
-    if method == 'post':
-      payload['page'] = page
-      return self._api_call(method, endpoint, payload=payload)
+  @property
+  def me(self):
+    return self.users.get_me()
 
+  @property
+  def telemetry(self):
+    return Telemetry(self)
 
-class FrameioClient(FrameioConnection):
   @property
   def _auth(self):
     return self.token
@@ -85,46 +30,46 @@ def _version(self):
 
   @property
   def _download(self):
-    return FrameioDownloader
+    return FrameioDownloader(self)
 
   @property
   def users(self):
-    from .service import User
+    from .services import User
     return User(self)
 
   @property
   def assets(self):
-    from .service import Asset
+    from .services import Asset
     return Asset(self)
 
   @property
   def comments(self):
-    from .service import Comment
+    from .services import Comment
     return Comment(self)
 
   @property
   def logs(self):
-    from .service import AuditLogs
+    from .services import AuditLogs
     return AuditLogs(self)
 
   @property
   def review_links(self):
-    from .service import ReviewLink
+    from .services import ReviewLink
     return ReviewLink(self)
 
   @property
   def presentation_links(self):
-    from .service import PresentationLink
+    from .services import PresentationLink
     return PresentationLink(self)
 
   @property
   def projects(self):
-    from .service import Project
+    from .services import Project
     return Project(self)
 
   @property
   def teams(self):
-    from .service import Team
+    from .services import Team
     return Team(self)
 
   @property

frameioclient/client.py

@@ -1,5 +1,8 @@
-from .download import FrameioDownloader
-from .upload import FrameioUploader
-from .utils import Utils, PaginatedResponse, KB, MB
 from .exceptions import *
+from .logger import SDKLogger
+from .telemetry import Telemetry
 from .version import ClientVersion
+from .upload import FrameioUploader
+from .download import FrameioDownloader
+from .transport import AWSClient, APIClient
+from .utils import Utils, PaginatedResponse, KB, MB

frameioclient/lib/__init__.py

@@ -0,0 +1,56 @@
+import speedtest
+
+class NetworkBandwidth:
+    # Test the network bandwidth any time we have a new IP address
+    # Persist this information to a config.json file
+
+    def __init__(self):
+        self.results = dict()
+
+    def load_stats(self):
+        # Force an update on these stats before starting download/upload
+        pass
+
+    def persist_stats(self):
+        pass
+
+    def run(self):
+        self.results = self.speed_test()
+
+    @staticmethod
+    def speedtest():
+        """
+        Run a speedtest using Speedtest.net in order to get a 'control' for \
+            bandwidth optimization.
+
+        Example::
+            NetworkBandwidth.speedtest()
+        """
+
+        st = speedtest.Speedtest()
+        download_speed = round(st.download(threads=10) * (1.192 * 10 ** -7), 2)
+        upload_speed = round(st.upload(threads=10) * (1.192 * 10 ** -7), 2)
+        servernames = []
+        server_names = st.get_servers(servernames)
+        ping = st.results.ping
+
+        return {
+            "ping": ping,
+            "download_speed": download_speed,
+            "upload_speed": upload_speed,
+        }
+
+    def __repr__(self):
+        self.results
+
+class DiskBandwidth:
+    # Test the disk speed and write to a config.json file for re-use
+    # Worth re-checking the disk every time a new one is detected (base route)
+    
+    def __init__(self, volume):
+        self.volume = volume
+        self.results = dict()
+
+    def __repr__(self):
+        self.results
+