set of utilities to integrate with Board CPM and BI toolkit
Project description
BoardUtils
BoardUtils is a set of utilities to integrate custom Python scripts / application with Board toolkit (https://www.board.com) This is an example package and should not be used to build production-grade integrations, it is intented to just showcase the functionalities of Board APIs
Installation
pip install boardutils
Usage
API Functionalities
from boardutils import api
bclient = api.Client("http://your-endpoint.board.com","client_id","client_secret") # create a new api client instance
layout_data = bclient.query("datamodel", "query-name","query-parameters") # return a dictionary with layout query results
cubes = bclient.cubes("datamodel") # return list of cubes for specified datamodel
entities = bclient.entities("datamodel") # return list of entities for specified datamodel
entity = bclient.entity("datamodel","entity") # return list of members of a specific entity
API Functionalities
from boardutils import sharedstorage
bss = sharedstorage.client("https://your-board-shared-storage-sas-uri-token.itsaverylongtoken.withlotsofsymbols") # new board shared storage client
bss.delete_file("azure_file","azure_directory") # Delete a file - if azure_directory parameter is missing, file deleted from root
bss.upload_file("azure_file","local_path","azure_directory") # Upload a file - if azure_directory parameter is missing, file upload to root
bss.download_file("azure_file","local_path","azure_directory") # Download a file - if azure_directory parameter is missing, file download from root
bss.download_file("azure_file","local_path","azure_directory") # Download a file - if azure_directory parameter is missing, file download from root
files = bss.list_directories_and_files("azure_directory") # list files and folders in a specified directory (if no path specified, root level). Return list of Azure file objects
for file in files:
file.name # to return the name of azure file from the azure file class
bss.get_file_size("azure_file","azure_directory") # return file size for specified azure file ((if no path specified, root level).
License
The usage of Board API Query engine is subject to licensing from Board (https://www.board.com) Please contact your account manager for more information
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
Close
Hashes for boardutils-0.7.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 987bbc8fd2a4ba4063f639b0f58a2005961e5b2e45eed70ce5f2f24172477839 |
|
MD5 | 9b0cd772aa4e44f1d5c003bf48d26fb6 |
|
BLAKE2b-256 | 32dffb856e18dbe23df168585364947772594e1fb0161e1e2943f04cc7875a65 |