Package: fds.sdk.Vault
Vault client library for PythonAllow clients to fetch Analytics through APIs.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 3.14.1Package version: 1.0.1Build package: org.openapitools.codegen.languages.PythonClientCodegenFor more information, please visithttps://developer.factset.com/contactRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.Vault==1.0.1pippipinstallfds.sdk.utilsfds.sdk.Vault==1.0.1UsageGenerate authentication credentials.Setup Python environment.Install and activate python 3.7+. If you're usingpyenv:pyenvinstall3.9.7
pyenvshell3.9.7(optional)Install poetry.Install dependencies.Run the following:fromfds.sdk.utils.authenticationimportConfidentialClientimportfds.sdk.Vaultfromfds.sdk.Vault.apiimportcomponents_apifromfds.sdk.Vault.modelsimport*fromdateutil.parserimportparseasdateutil_parserfrompprintimportpprint# 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 classconfiguration=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 clientwithfds.sdk.Vault.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_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 componenttry:# Get Vault component by id# example passing only required values which don't have defaults setapi_response=api_instance.get_vault_component_by_id(id)pprint(api_response)exceptfds.sdk.Vault.ApiExceptionase: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 PandasTo convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.importpandasaspdresponse_dict=api_response.to_dict()['data']simple_json_response=pd.DataFrame(response_dict)nested_json_response=pd.json_normalize(response_dict)DebuggingThe SDK uses the standard libraryloggingmodule.SettingdebugtoTrueon an instance of theConfigurationclass sets the log-level of related packages toDEBUGand enables additional logging in PythonsHTTP Client.Note: This prints out sensitive information (e.g. the full request and response). Use with care.importloggingimportfds.sdk.Vaultlogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.Vault.Configuration(...)configuration.debug=TrueConfigure a ProxyYou 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).importfds.sdk.Vaultconfiguration=fds.sdk.Vault.Configuration(# ...proxy="http://secret:password@localhost:5050",proxy_headers={"Custom-Proxy-Header":"Custom-Proxy-Header-Value"})Custom SSL CertificateTLS/SSL certificate verification can be configured with the following Configuration parameters:ssl_ca_cert: a path to the certificate to use for verification inPEMformat.verify_ssl: setting this toFalsedisables the verification of certificates.
Disabling the verification is not recommended, but it might be useful during
local development or testing.importfds.sdk.Vaultconfiguration=fds.sdk.Vault.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.comClassMethodHTTP requestDescriptionComponentsApiget_vault_component_by_idGET/analytics/engines/vault/v3/components/{id}Get Vault component by idComponentsApiget_vault_componentsGET/analytics/engines/vault/v3/componentsGet Vault componentsConfigurationsApiget_vault_configuration_by_idGET/analytics/engines/vault/v3/configurations/{id}Get Vault configuration by idConfigurationsApiget_vault_configurationsGET/analytics/engines/vault/v3/configurationsGet Vault configurationsDatesApiconvert_vault_dates_to_absolute_formatGET/analytics/engines/vault/v3/datesConvert Vault dates to absolute formatDocumentsApiget_vault_documentsGET/analytics/engines/vault/v3/documents/{path}Get Vault documents and sub-directories in a directoryFrequenciesApiget_vault_frequenciesGET/analytics/engines/vault/v3/frequenciesGet Vault frequenciesVaultCalculationsApicancel_calculation_by_idDELETE/analytics/engines/vault/v3/calculations/{id}Cancel Vault calculation by idVaultCalculationsApiget_all_calculationsGET/analytics/engines/vault/v3/calculationsGet all calculationsVaultCalculationsApiget_calculation_parametersGET/analytics/engines/vault/v3/calculations/{id}Get Vault calculation parameters by idVaultCalculationsApiget_calculation_status_by_idGET/analytics/engines/vault/v3/calculations/{id}/statusGet Vault calculation status by idVaultCalculationsApiget_calculation_unit_result_by_idGET/analytics/engines/vault/v3/calculations/{id}/units/{unitId}/resultGet Vault calculation result by idVaultCalculationsApipost_and_calculatePOST/analytics/engines/vault/v3/calculationsCreate and Run Vault calculationVaultCalculationsApiput_and_calculatePUT/analytics/engines/vault/v3/calculations/{id}Create or Update Vault calculation and run it.Documentation For ModelsCalculationMetaCalculationStatusCalculationStatusMetaCalculationStatusRootCalculationUnitStatusCalculationUnitStatusMetaCalculationsSummaryCalculationsSummaryRootClientErrorResponseComponentSummaryComponentSummaryRootConfigurationAccountDateParametersSummaryDateParametersSummaryRootDocumentDirectoriesDocumentDirectoriesRootErrorErrorSourceFrequencyFrequencyRootObjectRootPaginationInfoPaginationMetaVaultCalculationParametersVaultCalculationParametersRootVaultComponentVaultComponentRootVaultConfigurationVaultConfigurationRootVaultConfigurationSummaryVaultConfigurationSummaryRootVaultDateParametersVaultIdentifierDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf 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 DefaultApifrom fds.sdk.Vault.model.pet import PetSolution 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 *ContributingPlease refer to thecontributing guide.CopyrightCopyright 2022 FactSet Research Systems IncLicensed 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 athttp://www.apache.org/licenses/LICENSE-2.0Unless 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.