fds.sdk.Vermilion 1.2.1

Vermilion client library for Python

Vermilion client library for Python

Documentation on all available end points in the VRSAPI

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

• API version: 1.0.0
• SDK version: 1.2.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.Vermilion==1.2.1

pip

pip install fds.sdk.utils fds.sdk.Vermilion==1.2.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.Vermilion
from fds.sdk.Vermilion.api import datasource_api
from fds.sdk.Vermilion.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.Vermilion.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.Vermilion.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.Vermilion.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = datasource_api.DatasourceApi(api_client)
    tenant = "TENANT" # str | The code of the tenancy
    sort = ["name"] # [str] | The column to sort on. Append - to sort in descending order. If parameter is not given, no sorting will be done (optional)
    pagination_limit = 10 # int | Non-negative maximum number of entries to return. Default is 25 (optional) if omitted the server will use the default value of 25
    pagination_offset = 0 # int | Non-negative number of entries to skip. Default is 0 (optional) if omitted the server will use the default value of 0

    try:
        # Lists all datasources
        # example passing only required values which don't have defaults set
        # and optional values
        api_response = api_instance.get_all_data_sources(tenant, sort=sort, pagination_limit=pagination_limit, pagination_offset=pagination_offset)

        pprint(api_response)
    except fds.sdk.Vermilion.ApiException as e:
        print("Exception when calling DatasourceApi->get_all_data_sources: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # Lists all datasources
    #     api_response, http_status_code, response_headers = api_instance.get_all_data_sources_with_http_info(tenant, sort=sort, pagination_limit=pagination_limit, pagination_offset=pagination_offset)


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

    # # Get response asynchronous
    # try:
    #     # Lists all datasources
    #     async_result = api_instance.get_all_data_sources_async(tenant, sort=sort, pagination_limit=pagination_limit, pagination_offset=pagination_offset)
    #     api_response = async_result.get()


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

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Lists all datasources
    #     async_result = api_instance.get_all_data_sources_with_http_info_async(tenant, sort=sort, pagination_limit=pagination_limit, pagination_offset=pagination_offset)
    #     api_response, http_status_code, response_headers = async_result.get()


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

logging.basicConfig(level=logging.DEBUG)

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

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

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

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

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
DatasourceApi	get_all_data_sources	GET /v1/{tenant}/data-sources	Lists all datasources
DatasourceApi	get_data_source_by_code	GET /v1/{tenant}/data-sources/{dataSourceCode}	Gets a datasource
DatasourceApi	get_data_source_data	GET /v1/{tenant}/data-sources/{dataSourceCode}/data	Gets the data for the datasource
EntityApi	get_entity_values_by_code	GET /v1/{tenant}/entities/{entityCode}/values	Gets the entity values
ReportApi	get_all_report_definitions	GET /v1/{tenant}/reports	Gets all report definitions
ReportApi	get_report_definition_by_code	GET /v1/{tenant}/reports/{reportDefinitionCode}	Gets a report definition
ReportInstanceApi	cancel_report_generation	DELETE /v1/{tenant}/report-instances/{reportInstanceId}	Cancels a report generation
ReportInstanceApi	download_report_file	GET /v1/{tenant}/report-instances/{reportInstanceId}/results/{reportFileName}	Gets the generated file
ReportInstanceApi	get_all_report_instances	GET /v1/{tenant}/report-instances	Gets a list of report instances
ReportInstanceApi	get_report_generation_logs	GET /v1/{tenant}/report-instances/{reportInstanceId}/logs	Gets a list of logs for the report instance generation
ReportInstanceApi	get_report_instance_by_id	GET /v1/{tenant}/report-instances/{reportInstanceId}	Gets a report instance based on the ID
ReportInstanceApi	start_report_generation	POST /v1/report-instances/generate	Generates a report
SCIMApi	create_group	POST /scim/v2/Groups	Creates a role
SCIMApi	create_user	POST /scim/v2/Users	Creates a user
SCIMApi	delete_group_by_id	DELETE /scim/v2/Groups/{groupId}	Deletes a VRS role
SCIMApi	delete_user_by_id	DELETE /scim/v2/Users/{userId}	Deletes a VRS user
SCIMApi	get_all_groups	GET /scim/v2/Groups	Retrieves a list of VRS role
SCIMApi	get_all_users	GET /scim/v2/Users	Retrieves a list of VRS users
SCIMApi	get_group_by_id	GET /scim/v2/Groups/{groupId}	Retrieves a VRS role
SCIMApi	get_user_by_id	GET /scim/v2/Users/{userId}	Retrieves a VRS User
SCIMApi	patch_group_by_id	PATCH /scim/v2/Groups/{groupId}	Add or remove a user to/from a group
SCIMApi	patch_user_by_id	PATCH /scim/v2/Users/{userId}	Add or remove VRS user attributes
SCIMApi	update_group_by_id	PUT /scim/v2/Groups/{groupId}	Updates a VRS Group
SCIMApi	update_user_by_id	PUT /scim/v2/Users/{userId}	Updates a VRS user
VersionApi	get_version	GET /v1/version	Gets the version of VRS,WRS and DBServer
WorkflowApi	generate_schedule	POST /v1/{tenant}/schedules/{scheduleDefinitionCode}	Creates schedule for the specified schedule definition
WorkflowApi	get_schedule_definitions	GET /v1/{tenant}/schedule-definitions	Retrieves a list of all schedule definitions
WorkflowApi	get_schedule_generation_logs	GET /v1/{tenant}/schedules/{scheduleId}/logs	Gets the generation logs for a specific schedule
WorkflowApi	get_schedules	GET /v1/{tenant}/schedules	Retrieves a list of all schedules
WorkflowApi	update_schedule_status	PATCH /v1/{tenant}/schedules/{scheduleId}/{status}	Update schedule status for specified schedule

Documentation For Models

• CreateScimUserJSONRequest
• CreatedScimUserJSONResponse
• CreatedScimUserJSONResponseMeta
• DataSourceAllData
• DataSourceDTO
• DataSourceData
• DataSourceDataInstance
• DataSourceInstance
• DataSourceInstanceRows
• DataSourceList
• DataSourceListMeta
• DataSourceListMetaPagination
• EntityDTO
• EntityFieldValueDTO
• EntitySelection
• Error
• ErrorList
• GenerateScheduleResponse
• RecordSetFieldValues
• RecordSetFields
• ReportDefinitionDTO
• ReportDefinitionData
• ReportDefinitionList
• ReportGenerationRequest
• ReportGenerationRequestBody
• ReportInstanceDTO
• ReportInstanceData
• ReportInstanceDataResponse
• ReportInstanceId
• ReportInstanceList
• ReportInstanceListMeta
• ReportInstanceLogDTO
• ReportInstanceLogList
• ReportRevisionDTO
• ScheduleData
• ScheduleDefinition
• ScheduleDefinitionOwnerRole
• ScheduleDefinitionsList
• ScheduleGenerationLog
• ScheduleGenerationLogList
• ScheduleInstanceData
• ScheduleStatusUpdateResponse
• SchedulesList
• ScimEmail
• ScimError
• ScimGroup
• ScimGroupListResponse
• ScimGroupMember
• ScimGroupPatchOperation
• ScimGroupPatchOperationValue
• ScimGroupPatchRequestBody
• ScimMeta
• ScimPhone
• ScimPhoto
• ScimUser
• ScimUserGroup
• ScimUserListResponse
• ScimUserName
• ScimUserPatchOperation
• ScimUserPatchRequestBody
• Tenancy
• VersionResponseBody
• VersionResponseBodyData

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