factiva-core 0.1.6

Python package with root definitions and dictionaries, to support other functional packages.

Python package with root definitions and dictionaries, to support other functional packages.

• APIKeyUser: Represents an API user defined as a user key only (no O-Auth).

• StreamUser: Represents an user used for Streams which can authenticate with a user key.

• Dicts: Module that contains mulitple dictionaries for data combination or better human-reading.

Installation

To install this library, run the following commands. However, this library will be installed as a dependency of other Factiva or Dow Jones packages.

$ pip install --upgrade factiva-core

Using Library services

Quick examples that show how to use the included services.

Creating a User Instance and Getting its Status

Create an API-Key user instance, and retrieve a summary of current allowances and use.

from factiva.core import APIKeyUser
aku = APIKeyUser(api_key='abcd1234abcd1234abcd1234abcd1234', request_info=True)
print(aku)

<class 'factiva.core.apikeyuser.APIKeyUser'>
  api_key = ****************************1234
  account_name = Demo Account
  account_type = account_with_limits
  active_products = Snapshots
  max_allowed_concurrent_extractions = 2
  max_allowed_extracted_documents = 100000
  max_allowed_extractions = 10
  total_downloaded_bytes = 12345678
  total_extracted_documents = 5500
  total_extractions = 2
  total_stream_subscriptions = 2
  total_stream_topics = 1
  remaining_documents = 94500
  remaining_extractions = 8

Loading Factiva Industry Hierarchy

Loads the Industry hierarchy dataset which, among others, contain the Industry Factiva Code.

from factiva.core import dicts
ih = dicts.industries_hierarchy()
ih.head()

ind_fcode            name   parent
0   indroot  *DJ Industries
1        i0     Agriculture  indroot
2    i01001         Farming       i0
3    i03001     Aquaculture   i01001
4  i0100144   Cocoa Growing   i01001

Creating a StreamUser

Enables a user with a user-key to consult all the streams which have been done by its account Authenticates for Streams API (O-Auth or user-key) Creates Cient for Pubsub

from factiva.core import StreamUser
stream_user = StreamUser(
    api_key='****************************1234',
    request_info=False
)

print(stream_user.get_streams())
print(stream_user.get_client_subscription())

    type                                                 id  ...                                      relationships                                              links
0   stream  dj-synhub-stream-****************************1234...  ...   {'subscriptions': {'data': []}}  {'self': 'https://api.dowjones.com/alpha/strea...
1   stream  dj-synhub-stream-****************************1234...  ...   {'subscriptions': {'data': []}}  {'self': 'https://api.dowjones.com/alpha/strea...

<google.cloud.pubsub_v1.SubscriberClient object at 0x7fd36df36df0>