smartcitizen-connector 1.4.0

Python connector to download information collected in SmartCitizen API

Smart Citizen Connector

This is a connector written in python to get and post data from the Smart Citizen API. It can be used in conjunction with other scripts such as scdata.

Installation

Simply do:

pip install smartcitizen-connector

Development

Clone the repo and install in editable mode:

git clone [e-mail]:fablabbcn/smartcitizen-connector.git
cd smartcitizen-connector
pip install -e .

Usage

See docs for examples. a basic usage is shown below:

• Device (create and get data):

from smartcitizen_connector import SCDevice
import asyncio

d = SCDevice(16549)
print (d.json.name)
print (d.json.owner)

await d.get_data(freq = '1Min') # returns pandas dataframe
print (d.data)

• Search (see docs)

from smartcitizen_connector import search_by_query
# Users whose username contains "osc"
search_by_query(endpoint = 'users', key="username", search_matcher="cont", value="osc")
# Devices in which
search_by_query(endpoint = 'devices', key="name", search_matcher="cont", value="air")
# Devices created after (date greater than) "2023-08-11"
search_by_query(endpoint = 'devices', key="created_at", search_matcher="gt", value="2023-08-11")

• Authentication

Set the following environment variable with your Smart Citizen API token:

SC_BEARER=xxxxx