fds.sdk.PortfolioReportingBatcher 0.22.1

Portfolio Reporting Batcher client library for Python

Portfolio Reporting Batcher client library for Python

The Portfolio Reporting Batcher (PRB) API allows clients to systematically leverage functionalities of the PRB application. With the initial release, clients can

• trigger existing jobs
• check status of running jobs
• get various details of existing jobs

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

• API version: 0.4.0
• Package version: 0.22.1
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

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

Requirements

• Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.PortfolioReportingBatcher==0.22.1

pip

pip install fds.sdk.utils fds.sdk.PortfolioReportingBatcher==0.22.1

Usage

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

   1. Install and activate python 3.7+. 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:

[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

from fds.sdk.utils.authentication import ConfidentialClient

import fds.sdk.PortfolioReportingBatcher
from fds.sdk.PortfolioReportingBatcher.api import jobs_api
from fds.sdk.PortfolioReportingBatcher.models import *
from dateutil.parser import parse as dateutil_parser
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
#
# The confidential client instance should be reused in production environments.
# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication
# for more information on using the ConfidentialClient class
configuration = fds.sdk.PortfolioReportingBatcher.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.PortfolioReportingBatcher.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.PortfolioReportingBatcher.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    type = JobTypes("vault") # JobTypes | The jobs type
    name = "name_example" # str | The jobs name
    attribute = [
        "documents",
    ] # [str] | The attribute parameter accepts a list of the given enums, separated by commas. Each of them returns the respective data associated with the job. Runs returns the run history of the job. (optional)

    try:
        # Get details for the given PRB job
        # example passing only required values which don't have defaults set
        # and optional values
        api_response = api_instance.get_details_for_job(type, name, attribute=attribute)

        pprint(api_response)
    except fds.sdk.PortfolioReportingBatcher.ApiException as e:
        print("Exception when calling JobsApi->get_details_for_job: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # Get details for the given PRB job
    #     api_response, http_status_code, response_headers = api_instance.get_details_for_job_with_http_info(type, name, attribute=attribute)


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.PortfolioReportingBatcher.ApiException as e:
    #     print("Exception when calling JobsApi->get_details_for_job: %s\n" % e)

    # # Get response asynchronous
    # try:
    #     # Get details for the given PRB job
    #     async_result = api_instance.get_details_for_job_async(type, name, attribute=attribute)
    #     api_response = async_result.get()


    #     pprint(api_response)
    # except fds.sdk.PortfolioReportingBatcher.ApiException as e:
    #     print("Exception when calling JobsApi->get_details_for_job: %s\n" % e)

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Get details for the given PRB job
    #     async_result = api_instance.get_details_for_job_with_http_info_async(type, name, attribute=attribute)
    #     api_response, http_status_code, response_headers = async_result.get()


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.PortfolioReportingBatcher.ApiException as e:
    #     print("Exception when calling JobsApi->get_details_for_job: %s\n" % e)

Using Pandas

To convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.

import pandas as pd

response_dict = api_response.to_dict()['data']

simple_json_response = pd.DataFrame(response_dict)
nested_json_response = pd.json_normalize(response_dict)

Debugging

The SDK uses the standard library logging module.

Setting debug to True on an instance of the Configuration class sets the log-level of related packages to DEBUG and enables additional logging in Pythons HTTP Client.

Note: This prints out sensitive information (e.g. the full request and response). Use with care.

import logging
import fds.sdk.PortfolioReportingBatcher

logging.basicConfig(level=logging.DEBUG)

configuration = fds.sdk.PortfolioReportingBatcher.Configuration(...)
configuration.debug = True

Configure a Proxy

You can pass proxy settings to the Configuration class:

• proxy: The URL of the proxy to use.
• proxy_headers: a dictionary to pass additional headers to the proxy (e.g. Proxy-Authorization).

import fds.sdk.PortfolioReportingBatcher

configuration = fds.sdk.PortfolioReportingBatcher.Configuration(
    # ...
    proxy="http://secret:password@localhost:5050",
    proxy_headers={
        "Custom-Proxy-Header": "Custom-Proxy-Header-Value"
    }
)

Custom SSL Certificate

TLS/SSL certificate verification can be configured with the following Configuration parameters:

• ssl_ca_cert: a path to the certificate to use for verification in PEM format.
• verify_ssl: setting this to False disables the verification of certificates. Disabling the verification is not recommended, but it might be useful during local development or testing.

import fds.sdk.PortfolioReportingBatcher

configuration = fds.sdk.PortfolioReportingBatcher.Configuration(
    # ...
    ssl_ca_cert='/path/to/ca.pem'
)

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/analytics/prb/v0

Class	Method	HTTP request	Description
JobsApi	get_details_for_job	GET /jobs/{type}/{name}	Get details for the given PRB job
RunsApi	cancel_run_id	DELETE /runs/{id}	cancel runs
RunsApi	check_run_status	GET /runs/{id}/status	check the status for a particular run ID
RunsApi	start_job_run	POST /runs	trigger PRB jobs

Documentation For Models

• AccountsForJob
• AccountsForJobAddProp
• Calendar
• ClientErrorResponse
• DocumentsForJob
• Error
• ErrorSource
• Frequency
• IdStatus
• IdStatusData
• JobDetailsResponse
• JobDetailsResponseData
• JobOverrides
• JobOverridesCombinationsRoot
• JobOverridesDates
• JobTypes
• PrbStatus
• RunsForJob
• StartJob
• StartJobRoot
• StartJobRunResponse
• StartJobRunResponseData
• Status
• StatusDescription
• TasksForJob

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.PortfolioReportingBatcher.apis and fds.sdk.PortfolioReportingBatcher.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.PortfolioReportingBatcher.api.default_api import DefaultApi
• from fds.sdk.PortfolioReportingBatcher.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.PortfolioReportingBatcher
from fds.sdk.PortfolioReportingBatcher.apis import *
from fds.sdk.PortfolioReportingBatcher.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.