This is the python SDK for the FINBOURNE Scheduler API, part of the LUSID by FINBOURNE platform. To use it you'll need a LUSID account - sign up for free at lusid.com.
The Scheduler application provides automated job scheduling functionality - see https://support.lusid.com/knowledgebase/article/KA-01674/ to learn more.
For more details on other applications in the LUSID platform, see Understanding all the applications in the LUSID platform.
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. To find out which category an API endpoint falls into, see the swagger page.
This code is automatically generated by the OpenAPI Generator project.
- API version: 0.0.947
- SDK version: 2.1.59
- Python 3.7+
If using poetry
poetry add lusid-scheduler-sdk
If using pip
pip install lusid-scheduler-sdk
Then import the package in your python file
import lusid_schedulerYou'll need to provide some configuration to connect to the FINBOURNE Scheduler API - see the articles about short-lived access tokens and a long-lived Personal Access Token. 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. For a code illustration of this configuration being overridden, please see the example.
Required for a short-lived access token
FBN_TOKEN_URL
FBN_SCHEDULER_URL
FBN_USERNAME
FBN_PASSWORD
FBN_CLIENT_ID
FBN_CLIENT_SECRET
Required for a long-lived access token
FBN_SCHEDULER_URL
FBN_ACCESS_TOKEN
You can send your requests to the FINBOURNE Scheduler 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
# 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 2The 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
{
"api":
{
"tokenUrl":"<your-token-url>",
"schedulerUrl":"https://<your-domain>.lusid.com/scheduler2",
"username":"<your-username>",
"password":"<your-password>",
"clientId":"<your-client-id>",
"clientSecret":"<your-client-secret>",
}
}Required for a long-lived access token
{
"api":
{
"schedulerUrl":"https://<your-domain>.lusid.com/scheduler2",
"accessToken":"<your-access-token>"
}
}You can send your requests to the FINBOURNE Scheduler 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.
{
"api":
{
"schedulerUrl":"https://<your-domain>.lusid.com/scheduler2",
"accessToken":"<your-access-token>"
},
"proxy":
{
"address":"<your-proxy-address>",
"username":"<your-proxy-username>",
"password":"<your-proxy-password>"
}
}Other optional configuration
{
"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":<timeout-in-ms>, // the default is 1800000 (30 minutes)
"connectTimeoutMs":<timeout-in-ms>, // the default is 0 (no timeout)
"readTimeoutMs":<timeout-in-ms>, // the default is 0 (no timeout)
"rateLimitRetries":<retries-when-being-rate-limited> // the default is 2
}
}import asyncio
from lusid_scheduler.exceptions import ApiException
from lusid_scheduler.extensions.configuration_options import ConfigurationOptions
from lusid_scheduler.models import *
from pprint import pprint
from lusid_scheduler import (
ApiClientFactory,
ApplicationMetadataApi
)
async def main():
with open("secrets.json", "w") as file:
file.write('''
{
"api":
{
"tokenUrl":"<your-token-url>",
"schedulerUrl":"https://<your-domain>.lusid.com/scheduler2",
"username":"<your-username>",
"password":"<your-password>",
"clientId":"<your-client-id>",
"clientSecret":"<your-client-secret>"
}
}''')
# Use the lusid_scheduler ApiClientFactory 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 = ApiClientFactory(opts=opts)
api_client_factory = ApiClientFactory()
# Enter a context with an instance of the ApiClientFactory to ensure the connection pool is closed after use
async with api_client_factory:
# Create an instance of the API class
api_instance = api_client_factory.build(ApplicationMetadataApi)
try:
# uncomment the below to set overrides at the request level
# api_response = await api_instance.list_access_controlled_resources(opts=opts)
# [EXPERIMENTAL] ListAccessControlledResources: Get resources available for access control
api_response = await api_instance.list_access_controlled_resources()
pprint(api_response)
except ApiException as e:
print("Exception when calling ApplicationMetadataApi->list_access_controlled_resources: %s\n" % e)
asyncio.run(main())- See Documentation for API Endpoints for a description of each endpoint
- See Documentation for Models for descriptions of the models used
