Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/finbourne/workflow-sdk-python


https://github.com/finbourne/workflow-sdk-python

Last synced: 22 days ago
JSON representation

Awesome Lists containing this project

README 

        
![LUSID_by_Finbourne](./resources/Finbourne_Logo_Teal.svg)



# Python SDK for the FINBOURNE Workflow API



## Contents



- [Summary](#summary)

- [Versions](#versions)

- [Requirements](#requirements)

- [Installation](#installation)

- [Getting Started](#getting-started)

    * [Environment variables](#environment-variables)

    * [Secrets file](#secrets-file)

    * [Example](#example)

- [Endpoints and models](#endpoints-and-models)



## Summary



This is the python SDK for the FINBOURNE Workflow API, part of the [LUSID by FINBOURNE](https://www.finbourne.com/lusid-technology) platform. To use it you'll need a LUSID account - [sign up for free at lusid.com](https://www.lusid.com/app/signup).



Workflow provides functionality for automating the LUSID platform - see https://support.lusid.com/knowledgebase/article/KA-02181/ to learn more.



For more details on other applications in the LUSID platform, see [Understanding all the applications in the LUSID platform](https://support.lusid.com/knowledgebase/article/KA-01787).



This sdk supports `Production`, `Early Access`, `Beta` and `Experimental` API endpoints. For more details on API endpoint categories, see [What is the LUSID feature release lifecycle](https://support.lusid.com/knowledgebase/article/KA-01786). To find out which category an API endpoint falls into, see the [swagger page](https://fbn-prd.lusid.com/workflow/swagger/index.html).



This code is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project.



## Versions



- API version: 0.1.1359

- SDK version: 2.1.123



## Requirements



- Python 3.7+



## Installation



If using [poetry](https://python-poetry.org/docs/)



```

poetry add lusid-workflow-sdk

```



If using [pip](https://pypi.org/project/pip/)



```

pip install lusid-workflow-sdk

```



Then import the package in your python file

```python

import lusid_workflow

```



## Getting Started



You'll need to provide some configuration to connect to the FINBOURNE Workflow API - see the articles about [short-lived access tokens](https://support.lusid.com/knowledgebase/article/KA-01654) and a [long-lived Personal Access Token](https://support.lusid.com/knowledgebase/article/KA-01774). This configuration can be provided using a secrets file or environment variables.



For some configuration it is also possible to override the global configuration at the ApiClientFactory level, or at the request level. For the set of configuration which can be overridden, please see [ConfigurationOptions](sdk/lusid_workflow/extensions/configuration_options.py). For a code illustration of this configuration being overridden, please see the [example](#example).



### Environment variables



Required for a short-lived access token

``` 

FBN_TOKEN_URL

FBN_WORKFLOW_URL

FBN_USERNAME

FBN_PASSWORD

FBN_CLIENT_ID

FBN_CLIENT_SECRET

```



Required for a long-lived access token

``` 

FBN_WORKFLOW_URL

FBN_ACCESS_TOKEN

```



You can send your requests to the FINBOURNE Workflow API via a proxy, by setting `FBN_PROXY_ADDRESS`. If your proxy has basic auth enabled, you must also set `FBN_PROXY_USERNAME` and `FBN_PROXY_PASSWORD`.



Other optional configuration



```bash

# sdk client timeouts in milliseconds - a value of 0 means no timeout, otherwise timeout values must be a positive integer

# please note - the chances of seeing a network issue increase with the duration of the request

# for this reason, rather than increasing the timeout, it will be more reliable to use an alternate polling style endpoint where these exist

FBN_TOTAL_TIMEOUT_MS # the default is 1800000 (30 minutes)

FBN_CONNECT_TIMEOUT_MS # the default is 0 (no timeout)

FBN_READ_TIMEOUT_MS # the default is 0 (no timeout)

FBN_RATE_LIMIT_RETRIES # the default is 2

```



### Secrets file



The secrets file must be in the current working directory. By default the SDK looks for a secrets file called `secrets.json`



Required for a short-lived access token

```json

{

    "api":

    {

        "tokenUrl":"",

        "workflowUrl":"https://.lusid.com/workflow",

        "username":"",

        "password":"",

        "clientId":"",

        "clientSecret":"",

    }

}

```



Required for a long-lived access token

```json

{

    "api":

    {

        "workflowUrl":"https://.lusid.com/workflow",

        "accessToken":""

    }

}

```



You can send your requests to the FINBOURNE Workflow API via a proxy, by adding a proxy section. If your proxy has basic auth enabled, you must also supply a `username` and `password` in this section.



```json

{

    "api":

    {

        "workflowUrl":"https://.lusid.com/workflow",

        "accessToken":""

    },

    "proxy":

    {

        "address":"",

        "username":"",

        "password":""

    }

}

```



Other optional configuration



```javascript

{

    "api": 

    {

        // sdk client timeouts in milliseconds - a value of 0 means no timeout, otherwise timeout values must be a positive integer

        // please note - the chances of seeing a network issue increase with the duration of the request

        // for this reason, rather than increasing the timeout, it will be more reliable to use an alternate polling style endpoint where these exist

        "totalTimeoutMs":, // the default is 1800000 (30 minutes)

        "connectTimeoutMs":, // the default is 0 (no timeout)

        "readTimeoutMs":, // the default is 0 (no timeout)

        "rateLimitRetries": // the default is 2

    }

}

```



### Example

```python

from lusid_workflow.exceptions import ApiException

from lusid_workflow.extensions.configuration_options import ConfigurationOptions

from lusid_workflow.models import *

from pprint import pprint

from lusid_workflow import (

    SyncApiClientFactory,

    ActionLogsApi

)



def main():



    with open("secrets.json", "w") as file:

        file.write('''

    {

        "api":

        {

            "tokenUrl":"",

            "workflowUrl":"https://.lusid.com/workflow",

            "username":"",

            "password":"",

            "clientId":"",

            "clientSecret":""

        }

    }''')



    # Use the lusid_workflow SyncApiClientFactory to build Api instances with a configured api client

    # By default this will read config from environment variables

    # Then from a secrets.json file found in the current working directory



    # uncomment the below to use configuration overrides

    # opts = ConfigurationOptions();

    # opts.total_timeout_ms = 30_000



    # uncomment the below to use an api client factory with overrides

    # api_client_factory = SyncApiClientFactory(opts=opts)



    api_client_factory = SyncApiClientFactory()



    # Enter a context with an instance of the SyncApiClientFactory to ensure the connection pool is closed after use

    

    # Create an instance of the API class

    api_instance = api_client_factory.build(ActionLogsApi)

    id = 'id_example' # str | The Action Id



    try:

        # uncomment the below to set overrides at the request level

        # api_response =  api_instance.get_action_logs(id, opts=opts)



        # [EXPERIMENTAL] GetActionLogs: Get the Action Logs for an Action Id

        api_response = api_instance.get_action_logs(id)

        pprint(api_response)



    except ApiException as e:

        print("Exception when calling ActionLogsApi->get_action_logs: %s\n" % e)



main()

```



## Endpoints and models



- See [Documentation for API Endpoints](sdk/README.md#documentation-for-api-endpoints) for a description of each endpoint

- See [Documentation for Models](sdk/README.md#documentation-for-models) for descriptions of the models used