Python connector to download information collected in SmartCitizen API
Project description
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
Or clone the repo and install in editable mode:
git clone git@github.com:fablabbcn/smartcitizen-connector.git
cd smartcitizen-connector
pip install -e .
Usage
Device (create and get data - blazingly fast!):
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")
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
Built Distribution
Close
Hashes for smartcitizen-connector-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 75492bcd325872e945554f44de25e560bbf7ed90f62585f60fb94e241ab5c92c |
|
MD5 | 7073b9a79625c8a636b47395f70d4806 |
|
BLAKE2b-256 | 72b612bca61be37d2e24833eda34d9c5aebbc43744094a7bad930c74343b5d50 |
Close
Hashes for smartcitizen_connector-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c2ec492dfb48f0f8f1cb3aef345557c36d51a28e86a8e80ef6b88279cbe0ffc |
|
MD5 | 47bf53aec2bfa163190f82f16dc56040 |
|
BLAKE2b-256 | 7f9b6f681696793c866123720115269764882c28bc37d552c6b7248e15c18584 |