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
Metadata
1 maintainer
Release files for smartcitizen-connector 1.5.6
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.5.6.tar.gz | 32.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| smartcitizen_connector-1.5.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 70.1 kB
Release files / smartcitizen_connector-1.5.6.tar.gz
| Download URL | smartcitizen_connector-1.5.6.tar.gz |
|---|---|
| Size | 32.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
60ce9690f5de682ffdbd6d3b9edaac3966a800e3024de6d6ac233360ff1ae0f7
|
|
BLAKE2b-256 checksum How to use checksums |
7ffff616ea6b7a4fbf551fdc4f641dd076c71e82d27120d80ef4ae8d14911101
|
| 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.5.6-py3-none-any.whl
| Download URL | smartcitizen_connector-1.5.6-py3-none-any.whl |
|---|---|
| Size | 37.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8e56c26afedd62bc98ae748ac442ed4a802773f8efc068f49e14d26942800c1b
|
|
BLAKE2b-256 checksum How to use checksums |
fa2ff6a56d9d78ee09bb8cff67e27a516efd841ceecc32f7ec193c4dbb65cbe5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
