PA Engine client library for Python

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for factset from gravatar.com factset

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache License, Version 2.0
  • Author: FactSet Research Systems
  • Tags FactSet, API, SDK
  • Requires: Python >=3.7

Project description

FactSet

PA Engine client library for Python

API Version PyPi Apache-2 license

Allow clients to fetch Analytics through APIs.

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

  • API version: 3.16.0
  • SDK version: 2.1.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.protobuf.stach.extensions fds.sdk.PAEngine==2.1.1

pip

pip install fds.sdk.utils fds.protobuf.stach.extensions fds.sdk.PAEngine==2.1.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.PAEngine
from fds.sdk.PAEngine.api import accounts_api
from fds.sdk.PAEngine.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.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:" # str | The directory to get the accounts and sub-directories.

    try:
        # Get accounts and sub-directories in a directory
        # example passing only required values which don't have defaults set
        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)

    # # Get response, http status code and response headers
    # try:
    #     # Get accounts and sub-directories in a directory
    #     api_response, http_status_code, response_headers = api_instance.get_accounts_with_http_info(path)


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

    # # Get response asynchronous
    # try:
    #     # Get accounts and sub-directories in a directory
    #     async_result = api_instance.get_accounts_async(path)
    #     api_response = async_result.get()


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

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Get accounts and sub-directories in a directory
    #     async_result = api_instance.get_accounts_with_http_info_async(path)
    #     api_response, http_status_code, response_headers = async_result.get()


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.PAEngine.ApiException as e:
    #     print("Exception when calling AccountsApi->get_accounts: %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.PAEngine

logging.basicConfig(level=logging.DEBUG)

configuration = fds.sdk.PAEngine.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.PAEngine

configuration = fds.sdk.PAEngine.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.PAEngine

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

Request Retries

In case the request retry behaviour should be customized, it is possible to pass a urllib3.Retry object to the retry property of the Configuration.

from urllib3 import Retry
import fds.sdk.PAEngine

configuration = fds.sdk.PAEngine.Configuration(
    # ...
)

configuration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])

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.factset.com

Class Method HTTP request Description
AccountsApi get_accounts GET /analytics/lookups/v3/accounts/{path} Get accounts and sub-directories in a directory
ColumnStatisticsApi get_pa_column_statistics GET /analytics/engines/pa/v3/columnstatistics Get PA column statistics
ColumnsApi get_pa_column_by_id GET /analytics/engines/pa/v3/columns/{id} Get PA column settings
ColumnsApi get_pa_columns GET /analytics/engines/pa/v3/columns Get PA columns
ComponentsApi get_pa_component_by_id GET /analytics/engines/pa/v3/components/{id} Get PA component by id
ComponentsApi get_pa_components GET /analytics/engines/pa/v3/components Get PA components
CurrenciesApi get_currencies GET /analytics/lookups/v3/currencies Get currencies
DatesApi convert_pa_dates_to_absolute_format GET /analytics/engines/pa/v3/dates Convert PA dates to absolute format
DocumentsApi get_pa3_documents GET /analytics/engines/pa/v3/documents/{path} Get PA3 documents and sub-directories in a directory
FrequenciesApi get_pa_frequencies GET /analytics/engines/pa/v3/frequencies Get PA frequencies
GroupsApi get_pa_grouping_frequencies GET /analytics/engines/pa/v3/grouping-frequencies Get PA grouping frequencies
GroupsApi get_pa_groups GET /analytics/engines/pa/v3/groups Get PA groups
LinkedPATemplatesApi create_linked_pa_templates POST /analytics/engines/pa/v3/linked-templates Create a linked PA template
LinkedPATemplatesApi delete_linked_pa_templates DELETE /analytics/engines/pa/v3/linked-templates/{id} Delete a linked PA template.
LinkedPATemplatesApi get_linked_pa_templates GET /analytics/engines/pa/v3/linked-templates Get linked PA templates
LinkedPATemplatesApi get_linked_pa_templates_by_id GET /analytics/engines/pa/v3/linked-templates/{id} Get linked PA template by id
LinkedPATemplatesApi update_linked_pa_templates PUT /analytics/engines/pa/v3/linked-templates/{id} Update a linked PA template
PACalculationsApi cancel_calculation_by_id DELETE /analytics/engines/pa/v3/calculations/{id} Cancel PA calculation by id
PACalculationsApi generate_pa_portfolio_commentary POST /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary Generate PA portfolio commentary by calculation and unit id.
PACalculationsApi get_all_calculations GET /analytics/engines/pa/v3/calculations Get all calculations
PACalculationsApi get_calculation_parameters GET /analytics/engines/pa/v3/calculations/{id} Get PA calculation parameters by id
PACalculationsApi get_calculation_status_by_id GET /analytics/engines/pa/v3/calculations/{id}/status Get PA calculation status by id
PACalculationsApi get_calculation_unit_result_by_id GET /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result Get PA calculation result by id
PACalculationsApi get_pa_portfolio_commentary_result_by_id GET /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result Get PA Portfolio commentary result by calculation and unit id.
PACalculationsApi get_pa_portfolio_commentary_status_by_id GET /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status Get PA portfolio commentary status by calculation and unit id.
PACalculationsApi post_and_calculate POST /analytics/engines/pa/v3/calculations Create and Run PA calculation
PACalculationsApi put_and_calculate PUT /analytics/engines/pa/v3/calculations/{id} Create or Update PA calculation and run it.
PricingSourcesApi get_pa_pricing_sources GET /analytics/engines/pa/v3/pricing-sources Get PA pricing sources
TemplatedPAComponentsApi create_templated_pa_components POST /analytics/engines/pa/v3/templated-components Create templated PA component
TemplatedPAComponentsApi delete_templated_pa_components DELETE /analytics/engines/pa/v3/templated-components/{id} Delete templated PA component
TemplatedPAComponentsApi get_templated_pa_component_by_id GET /analytics/engines/pa/v3/templated-components/{id} Get templated PA component by id
TemplatedPAComponentsApi get_templated_pa_components_in_path GET /analytics/engines/pa/v3/templated-components Get templated PA components in path
TemplatedPAComponentsApi update_templated_pa_components PUT /analytics/engines/pa/v3/templated-components/{id} Update templated PA component
UnlinkedPATemplatesApi create_unlinked_pa_templates POST /analytics/engines/pa/v3/unlinked-templates Create unlinked PA template
UnlinkedPATemplatesApi delete_unlinked_pa_templates DELETE /analytics/engines/pa/v3/unlinked-templates/{id} Delete unlinked PA template
UnlinkedPATemplatesApi get_default_unlinked_pa_template_types GET /analytics/engines/pa/v3/unlinked-templates/template-types Get default unlinked PA template types.
UnlinkedPATemplatesApi get_details_type GET /analytics/engines/pa/v3/unlinked-templates/template-types/{id} Get unlinked PA template type details by id.
UnlinkedPATemplatesApi get_unlinked_pa_templates GET /analytics/engines/pa/v3/unlinked-templates Get unlinked PA templates
UnlinkedPATemplatesApi get_unlinked_pa_templates_by_id GET /analytics/engines/pa/v3/unlinked-templates/{id} Get unlinked PA template details by id
UnlinkedPATemplatesApi update_unlinked_pa_templates PUT /analytics/engines/pa/v3/unlinked-templates/{id} Update unlinked PA template

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.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.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for factset from gravatar.com factset

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache License, Version 2.0
  • Author: FactSet Research Systems
  • Tags FactSet, API, SDK
  • Requires: Python >=3.7

Release history Release notifications | RSS feed

This version

2.1.1

2.1.0

2.0.1

2.0.0

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

0.21.11

0.21.10

0.21.9

0.21.8

0.21.7

0.21.6

0.21.5

0.21.4

0.21.3

0.21.2

0.21.0

0.20.0

0.9.1

0.9.0

0.8.11

0.8.10

0.8.9

0.8.8

0.8.7

0.8.6

0.8.5

0.8.3

0.8.2

0.8.1

0.8.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fds.sdk.PAEngine-2.1.1.tar.gz (105.5 kB view hashes)

Uploaded Source

Built Distribution

fds.sdk.PAEngine-2.1.1-py3-none-any.whl (335.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page