Python package with root definitions and dictionaries, to support other functional packages. Get more details in the official documentation
- UserKey: Represents an API user defined as a user key only (no O-Auth). This class is used in the Snapshots & Streams services
- Dicts: Module that contains mulitple dictionaries for data combination or better human-reading.
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
Quick examples that show how to use the included services.
Create UserKey instance and retrieve a summary of the account statistics.
from factiva.core import UserKey
u = UserKey(key='abcd1234abcd1234abcd1234abcd1234', stats=True)
print(u)<class 'factiva.core.userkey.UserKey'>
|-key = ****************************1234
|-cloud_token = **Not Fetched**
|-account_name = AccName1234
|-account_type = account_with_contract_limits
|-active_products = DNA
|-max_allowed_concurrent_extractions = 5
|-max_allowed_extracted_documents = 200,000
|-max_allowed_extractions = 3
|-currently_running_extractions = 0
|-total_downloaded_bytes = 7,253,890
|-total_extracted_documents = 2,515
|-total_extractions = 1
|-total_stream_instances = 4
|-total_stream_subscriptions = 1
|-enabled_company_identifiers = [{'id': 4, 'name': 'isin'}, {'id': 3, 'name': 'cusip'}, {'id': 1, 'name': 'sedol'}, {'id': 5, 'name': 'ticker_exchange'}]
|-remaining_documents = 197,485
|-remaining_extractions = 2
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
To enable the proxy options on each request call, you need to set this environment variables
$ export HTTP_PROXY="http://10.10.1.10:3128" $ export HTTPS_PROXY="http://10.10.1.10:1080"
To use HTTP basic auth with your proxy, use the http://user:password@host/ syntax in any of the above configuration entries
$ export HTTPS_PROXY="http://user:[email protected]:1080"