Version 1.0.28: dataset.count support

Author: Dario Varotto

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## v1.0.28 (2019-05-15)
+**dataset.count method**
+
+```python
+dataset = api.get_dataset('us30')
+data_count = ds.count(
+    start_date='2018-01-05 18:00:00',
+    end_date='2018-01-05 18:01:00',
+)
+# {'count': 11, 'stories': 10, 'entities': 6}
+
+``` 

README.rst

@@ -117,18 +117,19 @@ some time to complete.
 Streaming real-time data
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-It is possible to subscribe to a real-time stream for a dataset:
+It is possible to subscribe to a real-time stream for a dataset.
 
-.. code:: python
+Once you create a streaming connection to the real-time feed with your
+dataset, you will receive analytics records as soon as they are
+published.
 
-    ds = api.get_dataset(dataset_id='us500')
-    for record in ds.request_realtime():
-        print(record)
-        print(record.timestamp_utc, record.entity_name,
-                  record['event_relevance'])
+It is suggested to handle possible disconnection with a retry policy.
+You can find a `real-time streaming example
+here <ravenpackapi/examples/get_realtime_news.py>`__.
 
-The Result object takes care of converting the various fields to the
-appropriate type, so ``record.timestamp_utc`` will be a ``datetime``
+The Result object handles the conversion of various fields into the
+appropriate type, i.e. ``record.timestamp_utc`` will be converted to
+``datetime``
 
 Entity mapping
 ~~~~~~~~~~~~~~
@@ -185,3 +186,29 @@ an Entity given the RP\_ENTITY\_ID
     for ticker in references.tickers:
         if ticker.is_valid():
             print(ticker)
+
+Accessing the low-level requests
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+RavenPack API wrapper is using the `requests
+library <https://2.python-requests.org>`__ to do HTTPS requests, you can
+set common requests parameters to all the outbound calls by setting the
+``common_request_params`` attribute.
+
+For example, to disable HTTPS certificate verification and to setup your
+internal proxy:
+
+.. code:: python
+
+    api = RPApi()
+    api.common_request_params.update(
+        dict(
+            proxies={'https': 'http://your_internal_proxy:9999'},
+            verify=False,
+        )
+    )
+
+    # use the api to do requests
+
+PS. For setting your internal proxies, requests will honor the
+HTTPS\_PROXY environment variable.

ravenpackapi/core.py

@@ -14,7 +14,7 @@
 from ravenpackapi.utils.constants import JSON_AVAILABLE_FIELDS, ENTITY_TYPES
 
 _VALID_METHODS = ('get', 'post', 'put', 'delete')
-VERSION = '1.0.27'
+VERSION = '1.0.28'
 
 logger = logging.getLogger("ravenpack.core")
 

ravenpackapi/examples/query_datafile_rollup.py

@@ -1,7 +1,6 @@
 import logging
 
 from ravenpackapi import RPApi, Dataset
-from ravenpackapi.models.job import Job
 
 logging.basicConfig(level=logging.INFO)
 # initialize the API (here we use the RP_API_KEY in os.environ)

ravenpackapi/models/dataset.py

@@ -181,6 +181,27 @@ def json(self,
         return Results(data['records'],
                        name='JSON query for %s' % dataset_id)
 
+    @api_method
+    def count(self, start_date, end_date):
+        """ Get the count of stories, analytics records and entities over a period
+        """
+        api = self.api
+        dataset_id = self.id
+
+        # let's build the body, with all the defined fields
+        body = {}
+        for k in JSON_AVAILABLE_FIELDS:
+            if locals().get(k) is not None:
+                body[k] = locals().get(k)
+
+        response = api.request(
+            endpoint="/datafile/{dataset_uuid}/count".format(dataset_uuid=dataset_id),
+            method='post',
+            data={"start_date": as_datetime_str(start_date),
+                  "end_date": as_datetime_str(end_date)}
+        )
+        return response.json()
+
     @api_method
     def request_datafile(self, start_date, end_date,
                          output_format='csv',

setup.py

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