fds.sdk.AnalyticsDatastore 0.20.0

Analytics Datastore client library for Python

Analytics Datastore client library for Python

Allow clients to fetch precalculated Analytics through predeterministic URLs.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1
• Package version: 0.20.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

• Python >= 3.6

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.AnalyticsDatastore

pip

pip install fds.sdk.utils fds.sdk.AnalyticsDatastore

Usage

1. Generate authentication credentials.
2. Setup Python environment.

   1. Install and activate python 3.6+. If you're using pyenv:

      pyenv install 3.9.7
      pyenv shell 3.9.7
      

   2. (optional) Install poetry.

3. Install dependencies.
4. Run the following:

from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.AnalyticsDatastore
from fds.sdk.AnalyticsDatastore.api import cargo_api
from pprint import pprint

# See configuration.py for a list of all supported configuration parameters.

# Examples for each supported authentication method are below,
# choose one that satisfies your use case.

# (Preferred) OAuth 2.0: FactSetOAuth2
# See https://github.com/FactSet/enterprise-sdk#oauth-20
# for information on how to create the app-config.json file
# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication
# for more information on using the ConfidentialClient class
configuration = fds.sdk.AnalyticsDatastore.Configuration(
    fds_oauth_client=ConfidentialClient('/path/to/app-config.json')
)

# Basic authentication: FactSetApiKey
# See https://github.com/FactSet/enterprise-sdk#api-key
# for information how to create an API key
# configuration = fds.sdk.AnalyticsDatastore.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.AnalyticsDatastore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cargo_api.CargoApi(api_client)
    group_id = "a4186c50f8e74f979d271dd22298c901" # str | The ID of the group (default to "a4186c50f8e74f979d271dd22298c901")
    object_id = "fe875bc4150542dea6bc237663a01a0d" # str | The ID of the object (default to "fe875bc4150542dea6bc237663a01a0d")

    # Get response
    try:
        # Get Cargo endpoint, gets an object given an ID. In this case ID retrieved from Swivel Location header, results in json response body of the report.
        api_response = api_instance.get_cargo_endpoint(group_id, object_id)
        pprint(api_response)
    except fds.sdk.AnalyticsDatastore.ApiException as e:
        print("Exception when calling CargoApi->get_cargo_endpoint: %s\n" % e)

    # Get response, http status code and response headers
    # try:
    #     # Get Cargo endpoint, gets an object given an ID. In this case ID retrieved from Swivel Location header, results in json response body of the report.
    #     api_response, http_status_code, response_headers = api_instance.get_cargo_endpoint_with_http_info(group_id, object_id)
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.AnalyticsDatastore.ApiException as e:
    #     print("Exception when calling CargoApi->get_cargo_endpoint: %s\n" % e)

    # Get response asynchronous
    # try:
    #     # Get Cargo endpoint, gets an object given an ID. In this case ID retrieved from Swivel Location header, results in json response body of the report.
    #     async_result = api_instance.get_cargo_endpoint_async(group_id, object_id)
    #     api_response = async_result.get()
    #     pprint(api_response)
    # except fds.sdk.AnalyticsDatastore.ApiException as e:
    #     print("Exception when calling CargoApi->get_cargo_endpoint: %s\n" % e)

    # Get response, http status code and response headers asynchronous
    # try:
    #     # Get Cargo endpoint, gets an object given an ID. In this case ID retrieved from Swivel Location header, results in json response body of the report.
    #     async_result = api_instance.get_cargo_endpoint_with_http_info_async(group_id, object_id)
    #     api_response, http_status_code, response_headers = async_result.get()
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.AnalyticsDatastore.ApiException as e:
    #     print("Exception when calling CargoApi->get_cargo_endpoint: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api-sandbox.factset.com

Class	Method	HTTP request	Description
CargoApi	get_cargo_endpoint	GET /analytics/pub-datastore/cargo/v1/groups/{groupId}/objects/{objectId}	Get Cargo endpoint, gets an object given an ID. In this case ID retrieved from Swivel Location header, results in json response body of the report.
SwivelApi	get_swivel_endpoint	GET /analytics/pub-datastore/swivel/v1/{pubDoc}/{assetName}/{reportId}/{tileId}/{accountId}	Get Swivel endpoint, takes report parameter inputs and returns the Cargo location for the specified report via a 302 redirect.

Documentation For Models

Documentation For Authorization

FactSetApiKey

• Type: HTTP basic authentication

FactSetOAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in fds.sdk.AnalyticsDatastore.apis and fds.sdk.AnalyticsDatastore.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from fds.sdk.AnalyticsDatastore.api.default_api import DefaultApi
• from fds.sdk.AnalyticsDatastore.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import fds.sdk.AnalyticsDatastore
from fds.sdk.AnalyticsDatastore.apis import *
from fds.sdk.AnalyticsDatastore.models import *

Contributing

Please refer to the contributing guide.

Copyright

Copyright 2022 FactSet Research Systems Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.