This package provides a set of utilities for use with the suite of FINBOURNE Python SDKs, this includes capabilities such as:

• authentication token acquisition
• refresh token
• request retries
• API construction

The SDK utilities package is available on PyPi and can be installed using the following:

pip install finbourne-sdk-utilities

The following configuration items are used by the utilities package to configure the SDK:

These configuration items must be exposed by an SDK via a utilities module containing a ConfigKeys class with get() classmethod that returns a dictionary of configuration keys/values.

mysdk/
|
...
├── utilities/
│   ├── __init__.py
│   └── ConfigKeys.py
...

An implementation of ConfigKeys.py may look like the example below where the keys are stored in a json file

class ConfigKeys:

    config_key_path = 'config_keys.json'

    @classmethod
    def get(cls):
        with open(Path(__file__).parent.joinpath(cls.config_key_path)) as json_file:
            config_keys = json.load(json_file)

        return config_keys

The returned values are a dictionary of configuration keys, containing a dictionary of key-values for the environment variables and json configuration files e.g.

{
    ...

    "token_url": {  
        "env": "FBN_TOKEN_URL",
        "config": "tokenUrl"
    },

    ...
}

The SDK utilities can be used with FINBOURNE SDKs such as the Luminesce Python SDK

import luminesce
from fbnsdkutilities import ApiClientFactory

factory = ApiClientFactory(luminesce)
sql_exec_api = factory.build(luminesce.api.SqlExecutionApi)

sql_exec_api.put_by_query_csv("""
    select * from lusid.portfolio limit 10
""")