Skip to main content

IRN Custom Symbols client library for Python

Project description

FactSet

IRN Custom Symbols client library for Python

PyPi Apache-2 license

Allows users to extract, create, update and configure IRN data.

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

  • API version: 1
  • Package version: 1.0.7
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

  • Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.IRNCustomSymbols==1.0.7

pip

pip install fds.sdk.utils fds.sdk.IRNCustomSymbols==1.0.7

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.IRNCustomSymbols
from fds.sdk.IRNCustomSymbols.api import custom_symbols_api
from fds.sdk.IRNCustomSymbols.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.IRNCustomSymbols.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.IRNCustomSymbols.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.IRNCustomSymbols.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = custom_symbols_api.CustomSymbolsApi(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.
    create_custom_symbol_dto = CreateCustomSymbolDto(
        code="code_example",
        name="name_example",
        description="description_example",
        type_id="type_id_example",
        sub_type_id="sub_type_id_example",
        google_maps_place_id="google_maps_place_id_example",
        formatted_address="formatted_address_example",
        city="city_example",
        state_province="state_province_example",
        postal_code="postal_code_example",
        country="country_example",
        custom_field_values=[
            CreateCustomSymbolCustomFieldValueDto(
                code="code_example",
                text_value="text_value_example",
                numeric_value=3.14,
                date_value="date_value_example",
                extended_text_value="extended_text_value_example",
                option_values=[
                    "option_values_example",
                ],
                contact_ids=[
                    "contact_ids_example",
                ],
            ),
        ],
    ) # CreateCustomSymbolDto | createCustomSymbolDto object to save (optional)

    try:
        # Create a custom symbol
        # example passing only required values which don't have defaults set
        # and optional values
        api_response = api_instance.create_custom_symbol(create_custom_symbol_dto=create_custom_symbol_dto)

        pprint(api_response)
    except fds.sdk.IRNCustomSymbols.ApiException as e:
        print("Exception when calling CustomSymbolsApi->create_custom_symbol: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # Create a custom symbol
    #     api_response, http_status_code, response_headers = api_instance.create_custom_symbol_with_http_info(create_custom_symbol_dto=create_custom_symbol_dto)


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

    # # Get response asynchronous
    # try:
    #     # Create a custom symbol
    #     async_result = api_instance.create_custom_symbol_async(create_custom_symbol_dto=create_custom_symbol_dto)
    #     api_response = async_result.get()


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

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Create a custom symbol
    #     async_result = api_instance.create_custom_symbol_with_http_info_async(create_custom_symbol_dto=create_custom_symbol_dto)
    #     api_response, http_status_code, response_headers = async_result.get()


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

logging.basicConfig(level=logging.DEBUG)

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

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

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

Documentation for API Endpoints

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

Class Method HTTP request Description
CustomSymbolsApi create_custom_symbol POST /v1/custom-symbols Create a custom symbol
CustomSymbolsApi delete_custom_symbol DELETE /v1/custom-symbols/{customSymbolId} Delete a custom symbol
CustomSymbolsApi get_custom_symbol GET /v1/custom-symbols/{customSymbolId} Get all custom field and standard field details on a specific custom symbol
CustomSymbolsApi get_custom_symbol_records GET /v1/custom-symbols/{customSymbolId}/records Get all notes and meetings where a specific customSymbol was tagged as primary or related identifier
CustomSymbolsApi get_custom_symbols GET /v1/custom-symbols Get list of all custom symbols in your group along with some of their standard field and custom fields data
CustomSymbolsApi link_custom_symbol_to_standard_symbol POST /v1/custom-symbols/{customSymbolId}/link-standard-symbol Link custom symbol to standard symbol
CustomSymbolsApi patch_custom_symbol PATCH /v1/custom-symbols/{customSymbolId} Edit a custom symbol’s standard field and custom field data
CustomSymbolsRelationshipsApi create_symbol_relationship POST /v1/symbol-relationships Create a symbol relationship
CustomSymbolsRelationshipsApi delete_symbol_relationship DELETE /v1/symbol-relationships/{symbolRelationshipId} Delete a symbol relationship
CustomSymbolsRelationshipsApi edit_and_add_symbol_relationship PUT /v1/symbol-relationships/{symbol} Edit a symbol relationship
CustomSymbolsRelationshipsApi get_symbol_relationship GET /v1/symbol-relationships/{symbolRelationshipId} Get details on a specific symbol relationship
CustomSymbolsRelationshipsApi get_symbol_relationships GET /v1/symbol-relationships/{symbolId}/relationships Returns a list of a symbol’s relationships
HybridSymbolsApi create_standard_symbol_metadata POST /v1/custom-symbols/standard-symbol-metadata Create standard symbol metadata
HybridSymbolsApi get_standard_symbol_metadata_guid GET /v1/custom-symbols/standard-symbol-metadata/{standardSymbol} Get all custom field and standard field details on a specific standard symbol
HybridSymbolsApi patch_standard_symbol PATCH /v1/custom-symbols/standard-symbol-metadata/{standardSymbolId} Edit a standard symbol’s standard field and custom field data

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.IRNCustomSymbols.apis and fds.sdk.IRNCustomSymbols.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.IRNCustomSymbols.api.default_api import DefaultApi
  • from fds.sdk.IRNCustomSymbols.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.IRNCustomSymbols
from fds.sdk.IRNCustomSymbols.apis import *
from fds.sdk.IRNCustomSymbols.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.IRNCustomSymbols-1.0.7-py3-none-any.whl (112.1 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