No project description provided
Project description
AIoT Studio
AIoT Studio is the official library to develop datasources and dependency sets for mnubo's AIoT Studio.
Installation
Requirements
- Python 2.7 or Python 3.4 and up
requests
pandas
≥ 0.20numpy
$ pip install aiot-studio
Simple datasource usage
from aiotstudio.datasource import search_df, log
def execute(parameters):
log.info("Hello aiot-studio")
result = search_df({
"from": "event",
"select": [{"count": "*"}]
})
return result
Configuration
The library needs to be configured with your mnubo API credentials. The credentials can be shared as follows (by decreasing order of priority):
- Environment variables:
MNUBO_CLIENT_ID
,MNUBO_CLIENT_SECRET
,MNUBO_API_URL
- Local config file:
application.conf
at the root of the project or anywhere indicated by theMNUBO_CONFIG_FILE
environment variable - Global config file:
~/.settings/mnubo/application.conf
(orC:\Users\<username>\.settings\mnubo\application.conf
on Windows)
For the last two options, the configuration file should look like this:
[DEFAULT]
mnubo_client_id = {API_CLIENT_ID}
mnubo_client_secret = {API_CLIENT_SECRET}
mnubo_api_url = https://prod.api.mnubo.com
Available methods
search(query)
: returns the search result as a JSONsearch_df(query)
: returns the search result as a Pandas DataFramelog
: Python logger: will appear in the "Logs" app, uselog.info
,log.warning
orlog.error
instead ofprint
blob_store_bucket_names()
: returns the bucket names availableblob_store_fetch(bucket_name, object_name)
: grabs the object from the bucket
Notes:
- All "search" methods expect a MQL query as described in the search API documentation
- Blob store methods are only available when the code runs inside mnubo's architecture, using it locally would throw a
FeatureUnavailableError
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
aiot-studio-1.0.14.tar.gz
(4.9 kB
view hashes)