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 git@github.com: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
1 maintainer
Release files for smartcitizen-connector 1.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| smartcitizen_connector-1.4.0.tar.gz | 30.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| smartcitizen_connector-1.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 65.2 kB
Release files / smartcitizen_connector-1.4.0.tar.gz
| Download URL | smartcitizen_connector-1.4.0.tar.gz |
|---|---|
| Size | 30.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
03c644e9053729568196862c811e1b3070c60c83441aeb8ac791b678fb60834e
|
|
BLAKE2b-256 checksum How to use checksums |
ded0311f1bf6bc8515030ec4f5370f39eab9a4d0dd0b9742d35f69e91562caf6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / smartcitizen_connector-1.4.0-py3-none-any.whl
| Download URL | smartcitizen_connector-1.4.0-py3-none-any.whl |
|---|---|
| Size | 35.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
af8fa96185a856a44a8e97017ad2cac9eb7bfffd45ac000a746e5918866f4272
|
|
BLAKE2b-256 checksum How to use checksums |
73496aaac207567c02273ec2b9a01c98fb0e1021600d7c452aad92c13678dfb4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
