version 1.0.50: Support for Insider-transactions and Earnings-Dates API

Author: dariosky

CHANGELOG.md

@@ -1,4 +1,7 @@
 # Changelog
+## v1.0.51 (2021-08-11)
+Insider-transactions and Earnings-Dates API support:
+list the available files and download them to automate your process
 
 ## v1.0.49 (2021-07-16)
 Text analytics: support for uploading via source_url

MANIFEST.in

@@ -3,8 +3,8 @@ include CONTRIBUTING.rst
 include HISTORY.rst
 include LICENSE
 include README.rst
-include ravenpackapi/upload/*
 
+recursive-include ravenpackapi *
 recursive-include tests *
 recursive-exclude * __pycache__
 recursive-exclude * .cache

ravenpackapi/core.py

@@ -3,6 +3,7 @@
 
 from ravenpackapi import Dataset
 from ravenpackapi.exceptions import get_exception
+from ravenpackapi.key_events.module import KeyEventsApi
 from ravenpackapi.models.dataset_list import DatasetList
 from ravenpackapi.models.job import Job
 from ravenpackapi.models.mapping import RPMappingResults
@@ -14,7 +15,7 @@
 from ravenpackapi.utils.dynamic_sessions import DynamicSession
 
 _VALID_METHODS = ('get', 'post', 'put', 'delete', 'patch')
-VERSION = '1.0.50'
+VERSION = '1.0.51'
 
 logger = logging.getLogger("ravenpack.core")
 
@@ -46,6 +47,8 @@ def __init__(self, api_key=None):
         self.log_curl_commands = True
         self.session = DynamicSession()
         self.upload = UploadApi(self)
+        self.insider_trasactions = KeyEventsApi(self, "insider-transactions")
+        self.earnings_dates = KeyEventsApi(self, "earnings-dates")
 
     @property
     def headers(self):

ravenpackapi/key_events/__init__.py

@@ -0,0 +1,53 @@
+import os
+
+from ravenpackapi.utils.file_saving import save_stream_response
+
+
+class KeyEventsApi(object):
+    def __init__(self, api, product):
+        self.api = api
+        self.product = product
+
+    def _request_list(self, file_type):
+
+        response = self.api.request(
+            "/%s/history/%s/" % (self.product, file_type)
+        )
+        data = response.json()
+        return data
+
+    def list_yearly_archives(self):
+        return self._request_list('yearly')
+
+    def list_daily_files(self):
+        return self._request_list('daily')
+
+    def list_reference_files(self):
+        return self._request_list('reference')
+
+    def download_file(self, file_id, filename=None):
+        if file_id.startswith("/"):
+            url = file_id
+            if filename is None:
+                filename = os.path.basename(file_id)
+        else:
+            # the id is the filename - we can get the url from there
+            if file_id.endswith(".zip"):
+                file_type = "yearly"
+            elif "-reference." in file_id:
+                file_type = "reference"
+            else:
+                file_type = "daily"
+            url = "/%(product)s/file/%(file_type)s/%(id)s" % {
+                "product": self.product,
+                "file_type": file_type,
+                "id": file_id
+            }
+            if filename is None:
+                filename = file_id
+        response = self.api.session.get(self.api._BASE_URL + url,
+                                        headers=self.api.headers,
+                                        stream=True,
+                                        **self.api.common_request_params
+                                        )
+        save_stream_response(response, filename=filename)

ravenpackapi/key_events/module.py

@@ -6,7 +6,8 @@
                                      APIException,
                                      DataFileTimeout,
                                      JobNotProcessing)
-from ravenpackapi.util import to_curl, parse_csv_line
+from ravenpackapi.util import parse_csv_line
+from ravenpackapi.utils.file_saving import save_stream_response
 
 logger = logging.getLogger(__name__)
 
@@ -104,26 +105,16 @@ def wait_for_completion(self, timeout_seconds=None):
     def save_to_file(self, filename):
         api = self.api
         job = self  # just to be clear
-        with open(filename, 'wb') as output:
-            job.wait_for_completion()
-            logger.info(u"Writing to %s" % filename)
-
-            # this is a different request than the normal API
-            # streaming the file in chunks
-            response = api.session.get(job.url,
-                                       headers=api.headers,
-                                       stream=True,
-                                       **api.common_request_params
-                                       )
-            if response.status_code != 200:
-                logger.error("Error calling the API, we tried: %s" % to_curl(response.request))
-                raise APIException(
-                    'Got an error {status}: body was \'{error_message}\''.format(
-                        status=response.status_code, error_message=response.text
-                    ), response=response)
-            for chunk in response.iter_content(chunk_size=self._CHUNK_SIZE):
-                if chunk:
-                    output.write(chunk)
+        job.wait_for_completion()
+
+        # this is a different request than the normal API
+        # streaming the file in chunks
+        response = api.session.get(job.url,
+                                   headers=api.headers,
+                                   stream=True,
+                                   **api.common_request_params
+                                   )
+        save_stream_response(response, filename, chunk_size=self._CHUNK_SIZE)
 
     @api_method
     def iterate_results(self, include_headers=False):

ravenpackapi/models/job.py

@@ -0,0 +1,21 @@
+import logging
+
+from ravenpackapi.exceptions import APIException
+from ravenpackapi.util import to_curl
+
+logger = logging.getLogger(__name__)
+
+
+def save_stream_response(response, filename, chunk_size=8192):
+    if response.status_code != 200:
+        logger.error("Error calling the API, we tried: %s" % to_curl(response.request))
+        raise APIException(
+            'Got an error {status}: body was \'{error_message}\''.format(
+                status=response.status_code, error_message=response.text
+            ), response=response)
+
+    logger.info(u"Writing to %s" % filename)
+    with open(filename, "wb") as output:
+        for chunk in response.iter_content(chunk_size=chunk_size):
+            if chunk:
+                output.write(chunk)

ravenpackapi/utils/file_saving.py

@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-VERSION = '1.0.50'
+VERSION = '1.0.51'
 
 with open('README.rst') as readme_file:
     readme = readme_file.read()