Basking.io python SDK
Project description
Basking.io SDK
Integrate your data with the Basking API, customize the reports & experience, and join the community of developers building with workplace software apps together with Basking.
Basking.io is a cloud based workplace occupancy platform. More Information about Basking can be found here: https://basking.io
Basking uses a GraphQL API. The following Python SDK is a wrapper around the production API designed for our customers that require to access to data programmatically.
Requirements
- python >=3.7 (current tested version: 3.9)
- pipenv
- A basking.io account
Getting started
set the following environment variables:
BASKING_USERNAME
: Your username (usually your email)BASKING_USER_PASSWORD
: Your password for Basking.- Optional:
BASKING_AWS_REGION
: the aws region where your Basking.io instance is hosted. (Defaults toeu-central-1
) - Optional:
BASKING_API_URL
: the url of the Basking API you would like to query. (Defaults toapi.basking.io
)
import logging
from basking.basking_sdk import Basking
# set the default logging
logging.basicConfig()
# mofify the required level of logging for Basking
logging.getLogger('Basking').setLevel(logging.INFO)
logging.getLogger('botocore').setLevel(logging.INFO)
# initialize the SDK and set general query parameters
basking_client = Basking()
# list buildings the current user has access to
df_buildings = basking_client.location.get_user_buildings(pandify=True)
# get building meta data
building_meta_data = basking_client.location.get_building(
building_id=building_id
)
tz_str = building_meta_data['data']['getBuilding']['timeZone']
# get building daily occupancy statistics
df_daily = basking_client.occupancy.get_building_occupancy_stats_daily(
building_id=building_id,
start_obj_tz_unaware=start_date_obj,
end_obj_tz_unaware=end_date_obj,
pandify=True
)
df_daily.to_csv('./df_daily.csv')
For more examples, see basking.api_usage_example
, or contact us
Project details
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
basking-sdk-0.9.53.tar.gz
(18.1 kB
view hashes)
Built Distribution
Close
Hashes for basking_sdk-0.9.53-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41a22b6109622df11468cb3e043ce71ce1fd7929c901782d79b4d7e54463ac6c |
|
MD5 | fd5d1137f782d3dac68591c33873d0d8 |
|
BLAKE2b-256 | 26a48914905bb1f9b3579944b3758834645673efb9bc21d3722eafb2570e4d77 |