Skip to main content

Vault client library for Python

Project description

FactSet

Vault client library for Python

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
  • Package version: 0.21.7
  • 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.Vault

pip

pip install fds.sdk.utils fds.sdk.Vault

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:
from fds.sdk.utils.authentication import ConfidentialClient

import fds.sdk.Vault
from fds.sdk.Vault.api import components_api
from fds.sdk.Vault.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
# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication
# for more information on using the ConfidentialClient class
configuration = fds.sdk.Vault.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.Vault.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.Vault.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = components_api.ComponentsApi(api_client)
    # NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.
    id = "id_example" # str | Unique identifier for a vault component

    try:
        # Get Vault component by id
        # example passing only required values which don't have defaults set
        api_response = api_instance.get_vault_component_by_id(id)

        pprint(api_response)
    except fds.sdk.Vault.ApiException as e:
        print("Exception when calling ComponentsApi->get_vault_component_by_id: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # Get Vault component by id
    #     api_response, http_status_code, response_headers = api_instance.get_vault_component_by_id_with_http_info(id)


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

    # # Get response asynchronous
    # try:
    #     # Get Vault component by id
    #     async_result = api_instance.get_vault_component_by_id_async(id)
    #     api_response = async_result.get()


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

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Get Vault component by id
    #     async_result = api_instance.get_vault_component_by_id_with_http_info_async(id)
    #     api_response, http_status_code, response_headers = async_result.get()


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

logging.basicConfig(level=logging.DEBUG)

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

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

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

Documentation for API Endpoints

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

Class Method HTTP request Description
ComponentsApi get_vault_component_by_id GET /analytics/engines/vault/v3/components/{id} Get Vault component by id
ComponentsApi get_vault_components GET /analytics/engines/vault/v3/components Get Vault components
ConfigurationsApi get_vault_configuration_by_id GET /analytics/engines/vault/v3/configurations/{id} Get Vault configuration by id
ConfigurationsApi get_vault_configurations GET /analytics/engines/vault/v3/configurations Get Vault configurations
DatesApi convert_vault_dates_to_absolute_format GET /analytics/engines/vault/v3/dates Convert Vault dates to absolute format
DocumentsApi get_vault_documents GET /analytics/engines/vault/v3/documents/{path} Get Vault documents and sub-directories in a directory
FrequenciesApi get_vault_frequencies GET /analytics/engines/vault/v3/frequencies Get Vault frequencies
VaultCalculationsApi cancel_calculation_by_id DELETE /analytics/engines/vault/v3/calculations/{id} Cancel Vault calculation by id
VaultCalculationsApi get_all_calculations GET /analytics/engines/vault/v3/calculations Get all calculations
VaultCalculationsApi get_calculation_parameters GET /analytics/engines/vault/v3/calculations/{id} Get Vault calculation parameters by id
VaultCalculationsApi get_calculation_status_by_id GET /analytics/engines/vault/v3/calculations/{id}/status Get Vault calculation status by id
VaultCalculationsApi get_calculation_unit_result_by_id GET /analytics/engines/vault/v3/calculations/{id}/units/{unitId}/result Get Vault calculation result by id
VaultCalculationsApi post_and_calculate POST /analytics/engines/vault/v3/calculations Create and Run Vault calculation
VaultCalculationsApi put_and_calculate PUT /analytics/engines/vault/v3/calculations/{id} Create or Update Vault calculation and run it.

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


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

fds.sdk.Vault-0.21.7-py3-none-any.whl (146.4 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