fds.sdk.PAEngine 0.8.1

PA Engine client library for Python

PA Engine client library for Python

Allow clients to fetch PA Engine Analytics through APIs.

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

• API version: 2
• Package version: 0.8.1
• 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.PAEngine

pip

pip install fds.sdk.utils fds.sdk.PAEngine

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.PAEngine
from fds.sdk.PAEngine.api import accounts_api
from fds.sdk.PAEngine.model.account_directories import AccountDirectories
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.PAEngine.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.PAEngine.Configuration(
#     username = 'USERNAME-SERIAL',
#     password = 'API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.PAEngine.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = accounts_api.AccountsApi(api_client)
    path = "Client:Foo/Bar" # str | The directory to get the accounts and sub-directories in (default to "Client:Foo/Bar")

    try:
        # Get accounts and sub-directories in a directory
        api_response = api_instance.get_accounts(path)
        pprint(api_response)
    except fds.sdk.PAEngine.ApiException as e:
        print("Exception when calling AccountsApi->get_accounts: %s\n" % e)

STACH extensions

Some methods within this client library are able to return STACH formatted data. Please see the documentation of those endpoints on how to enable and use STACH formatted data.

Documentation of the STACH extension can be found here: stach-extensions and here STACH schema

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AccountsApi	get_accounts	GET /analytics/lookups/v2/accounts/{path}	Get accounts and sub-directories in a directory
CalculationsApi	cancel_calculation_by_id	DELETE /analytics/engines/v2/calculations/{id}	Cancel calculation by id
CalculationsApi	get_calculation_status_by_id	GET /analytics/engines/v2/calculations/{id}	Get calculation status by id
CalculationsApi	get_calculation_status_summaries	GET /analytics/engines/v2/calculations	Get all calculation statuses
CalculationsApi	run_calculation	POST /analytics/engines/v2/calculations	Run calculation
ColumnStatisticsApi	get_pa_column_statistics	GET /analytics/lookups/v2/engines/pa/columnstatistics	Get PA column statistics
ColumnsApi	get_pa_column_by_id	GET /analytics/lookups/v2/engines/pa/columns/{id}	Get PA column settings
ColumnsApi	get_pa_columns	GET /analytics/lookups/v2/engines/pa/columns	Get PA columns
ComponentsApi	get_pa_component_by_id	GET /analytics/lookups/v2/engines/pa/components/{id}	Get PA component by id
ComponentsApi	get_pa_components	GET /analytics/lookups/v2/engines/pa/components	Get PA components
CurrenciesApi	get_pa_currencies	GET /analytics/lookups/v2/engines/pa/currencies	Get PA currencies
DatesApi	convert_pa_dates_to_absolute_format	GET /analytics/lookups/v2/engines/pa/dates	Convert PA dates to absolute format
DocumentsApi	get_pa3_documents	GET /analytics/lookups/v2/engines/pa/documents/{path}	Get PA3 documents and sub-directories in a directory
FrequenciesApi	get_pa_frequencies	GET /analytics/lookups/v2/engines/pa/frequencies	Get PA frequencies
GroupsApi	get_pa_groups	GET /analytics/lookups/v2/engines/pa/groups	Get PA groups

Documentation For Models

• AccountDirectories
• Calculation
• CalculationStatus
• CalculationStatusSummary
• CalculationUnitStatus
• Column
• ColumnStatistic
• ColumnSummary
• ComponentAccount
• ComponentBenchmark
• ComponentSummary
• Currency
• DateParametersSummary
• DocumentDirectories
• Frequency
• Group
• PACalculationColumn
• PACalculationGroup
• PACalculationParameters
• PAComponent
• PADateParameters
• PAIdentifier
• PubCalculationParameters
• PubDateParameters
• PubIdentifier
• SPARCalculationParameters
• SPARDateParameters
• SPARIdentifier
• VaultCalculationParameters
• VaultDateParameters
• VaultIdentifier

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