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.5
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.5.tar.gz | 32.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| smartcitizen_connector-1.5.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 69.3 kB
Release files / smartcitizen_connector-1.5.5.tar.gz
| Download URL | smartcitizen_connector-1.5.5.tar.gz |
|---|---|
| Size | 32.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
efbc6c0e5f3c557775c940c788c6fdbc97525a1490352405984c79732fffd934
|
|
BLAKE2b-256 checksum How to use checksums |
91556a23cfd7034a9ed98fcdd6a303d11f9764649a97dc3662a7807cdcede01e
|
| 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.5-py3-none-any.whl
| Download URL | smartcitizen_connector-1.5.5-py3-none-any.whl |
|---|---|
| Size | 36.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5b9a13b9b2b8e4476bd40657e9cf3293a1168574489e8a2259bc97424bceff0f
|
|
BLAKE2b-256 checksum How to use checksums |
318cd9a53fdeef7ba1d182295cf6b3133a9fbbb0192d8d8127b8f8c7048bfcf3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
