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.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a73002e89ea77c579e8387682d9856c28d9366933206bb54cab2bdcb5c66f329 |
|
MD5 | f5f004a3eb077363b7d0b684ca542b32 |
|
BLAKE2b-256 | f118127462d3afd8024ccbcf29750776a94cad489cdce2e48a494b91554bf155 |
Close
Hashes for smartcitizen_connector-1.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d0c5f55676a0f06a33c8fa50e22516bffb02de63290941d919e9f3286bfa29c |
|
MD5 | 1d6dd71a0f7fc76be94ae7ac9aca7697 |
|
BLAKE2b-256 | ccd61c45bb2c1055816311a59f41d0ac64e16d16ea5408803355a683aadb0d6d |