FINBOURNE Drive API
Project description
lusid-drive-sdk
FINBOURNE Technology
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 0.1.636
- Package version: 2.1.8
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.finbourne.com
Requirements.
Python 3.7+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/finbourne/drive-sdk-python.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/finbourne/drive-sdk-python.git)
Then import the package:
import lusid_drive
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import lusid_drive
Tests
Execute pytest to run the tests.
Getting Started
You'll need to provide some configuration to connect to the lusid_drive application. These can be provided using a secrets file or environment variables.
Environment variables
In order to use short lived access tokens you will need to have appropriate values set for the following environment variables:
FBN_TOKEN_URL,
FBN_LUSID_DRIVE_API_URL,
FBN_USERNAME,
FBN_PASSWORD,
FBN_CLIENT_ID,
FBN_CLIENT_SECRET
To use a long lived Personal Access Token, you must provide the following environment variables:
FBN_LUSID_DRIVE_API_URL,
FBN_ACCESS_TOKEN
You can send your requests to lusid_drive via a proxy, by setting FBN_PROXY_ADDRESS.
If your proxy has basic auth enabled, you must akso supply FBN_PROXY_USERNAME and FBN_PROXY_PASSWORD
Secrets file
In order to use short lived access tokens you will need to have appropriate values set in a secrets.json file in the same folder as your script.
{
"api":
{
"tokenUrl":"<your-token-url>",
"lusid_driveUrl":"<FINBOURNE-application-url>",
"username":"<your-username>",
"password":"<your-password>",
"clientId":"<your-client-id>",
"clientSecret":"<your-client-secret>",
}
}
To use a long lived Personal Access Token, you must provide a secrets.json with the following variables:
{
"api":
{
"lusid_driveUrl":"<FINBOURNE-application-url>",
"accessToken":"<your-access-token>"
}
}
You can send your requests to lusid_drive via a proxy, by adding a proxy section to your secrets.json.
If your proxy has basic auth enabled, you must also supply a username and password in this section.
{
"api":
{
"lusid_driveUrl":"<FINBOURNE-application-url>",
"accessToken":"<your-access-token>"
},
"proxy":
{
"address":"<your-proxy-address>",
"username":"<your-proxy-username>",
"password":"<your-proxy-password>"
}
}
Using the SDK
Please follow the installation procedure and then run the following:
import time
import lusid_drive
from lusid_drive.exceptions import ApiException
from pprint import pprint
import os
from lusid_drive import (
ApiClientFactory,
ApplicationMetadataApi,
EnvironmentVariablesConfigurationLoader,
SecretsFileConfigurationLoader,
ArgsConfigurationLoader
)
# Use the lusid_drive 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
api_client_factory = ApiClientFactory()
# The ApiClientFactory can be passed an iterable of configuration loaders to read configuration from
api_url = "https://fbn-prd.lusid.com/drive"
# Path to a secrets.json file containing authentication credentials
# See https://support.lusid.com/knowledgebase/article/KA-01667/en-us
# for a detailed guide to setting up the SDK make authenticated calls to LUSID APIs
secrets_path = os.getenv("FBN_SECRETS_PATH")
app_name="LusidJupyterNotebook"
config_loaders = [
EnvironmentVariablesConfigurationLoader(),
SecretsFileConfigurationLoader(api_secrets_file=secrets_path),
ArgsConfigurationLoader(api_url=api_url, app_name=app_name)
]
api_client_factory = ApiClientFactory(config_loaders=config_loaders)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# 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:
# [EARLY ACCESS] ListAccessControlledResources: Get resources available for access control
api_response = await api_instance.list_access_controlled_resources()
print("The response of ApplicationMetadataApi->list_access_controlled_resources:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ApplicationMetadataApi->list_access_controlled_resources: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://fbn-prd.lusid.com/drive
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ApplicationMetadataApi | list_access_controlled_resources | GET /api/metadata/access/resources | [EARLY ACCESS] ListAccessControlledResources: Get resources available for access control |
| FilesApi | create_file | POST /api/files | [EARLY ACCESS] CreateFile: Uploads a file to Lusid Drive. If using an SDK, consider using the UploadAsStreamAsync function for larger files instead. |
| FilesApi | delete_file | DELETE /api/files/{id} | [EARLY ACCESS] DeleteFile: Deletes a file from Drive. |
| FilesApi | download_file | GET /api/files/{id}/contents | [EARLY ACCESS] DownloadFile: Download the file from Drive. |
| FilesApi | get_file | GET /api/files/{id} | [EARLY ACCESS] GetFile: Get a file stored in Drive. |
| FilesApi | update_file_contents | PUT /api/files/{id}/contents | [EARLY ACCESS] UpdateFileContents: Updates contents of a file in Drive. |
| FilesApi | update_file_metadata | PUT /api/files/{id} | [EARLY ACCESS] UpdateFileMetadata: Updates metadata for a file in Drive. |
| FoldersApi | create_folder | POST /api/folders | [EARLY ACCESS] CreateFolder: Create a new folder in LUSID Drive |
| FoldersApi | delete_folder | DELETE /api/folders/{id} | [EARLY ACCESS] DeleteFolder: Delete a specified folder and all subfolders |
| FoldersApi | get_folder | GET /api/folders/{id} | [EARLY ACCESS] GetFolder: Get metadata of folder |
| FoldersApi | get_folder_contents | GET /api/folders/{id}/contents | [EARLY ACCESS] GetFolderContents: List contents of a folder |
| FoldersApi | get_root_folder | GET /api/folders | [EARLY ACCESS] GetRootFolder: List contents of root folder |
| FoldersApi | move_folder | POST /api/folders/{id} | [EARLY ACCESS] MoveFolder: Move files to specified folder |
| FoldersApi | update_folder | PUT /api/folders/{id} | [EARLY ACCESS] UpdateFolder: Update an existing folder's name, path |
| SearchApi | search | POST /api/search | [EARLY ACCESS] Search: Search for a file or folder with a given name and path |
Documentation For Models
- AccessControlledAction
- AccessControlledResource
- ActionId
- CreateFolder
- IdSelectorDefinition
- IdentifierPartSchema
- Link
- LusidProblemDetails
- LusidValidationProblemDetails
- PagedResourceListOfStorageObject
- ResourceListOfAccessControlledResource
- SearchBody
- StorageObject
- UpdateFile
- UpdateFolder
Documentation For Authorization
Authentication schemes defined for the API:
oauth2
- Type: OAuth
- Flow: implicit
- Authorization URL: https://lusid.okta.com/oauth2/default/v1/authorize
- Scopes: N/A
Author
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for lusid_drive_sdk-2.1.8-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 21f84b9420f3b7f4050f654b82bea95bba2de63e463472506bb62eed9c67c8bd |
|
| MD5 | 090b360a9bd07aafd8133c427e254e1a |
|
| BLAKE2b-256 | 673007ceebccb2d511ecbe3be43e0346353e142d9c7407845e4444516adfa513 |
