Simplifies using the India Urban Data Exchange IUDX platform. Provides an API interface to perform scientific computing over various smart city resources. Vist the IUDX Catalogue to discover datasets of your interest.
pip install git+https://github.com/datakaveri/iudx-python-sdkA simple IPython notebook going throught the entire process flow can be found here. Getting Started.ipynb
A sample notebook to download sensors' data is also available. Download ITMS Dataset.ipynb
- Get the catalogue list of all sensors based on a text search query.
from iudx.cat.Catalogue import Catalogue
from iudx.cat.CatalogueQuery import CatalogueQuery
# creating an object of Catalogue class using cat_url.
cat = Catalogue(
cat_url="https://api.catalogue.iudx.org.in/iudx/cat/v1",
headers={"content-type": "application/json"}
)
# creating a query for text search
cat_query = CatalogueQuery()
query = cat_query.text_search("aqm")
# fetching the search response for the query
result = cat.search_entity(query)
print(f"RESULTS: {result.documents}") # get all the search documents as json.
print(f"STATUS: {result.status}") # get the status for the search response.
print(f"TOTAL HITS: {result.total_hits}") # get the count of total results fetched. - Get the latest data for specific entity id.
from iudx.rs.ResourceServer import ResourceServer
from iudx.rs.ResourceQuery import ResourceQuery
# entity id for the pune env aqm sensor.
entity_id = "datakaveri.org/04a15c9960ffda227e9546f3f46e629e1fe4132b/rs.iudx.org.in/pune-env-aqm/f36b4669-628b-ad93-9970-f9d424afbf75"
# creating an object of ResourceServer class using rs_url.
rs = ResourceServer(
rs_url="https://rs.iudx.org.in/ngsi-ld/v1",
headers={"content-type": "application/json"}
)
# creating a query for fetching latest data for the entity_id.
rs_query = ResourceQuery()
rs_entity = rs_query.add_entity(entity_id)
# fetch results for a list of entities.
results = rs.get_latest([rs_entity])
# printing results
print(f"RESULTS: {results[0].results}") # get the result data of the resource query.
print(f"STATUS: {results[0].type}") # get the status code for the response.- Get the during data for specific entity id.
from iudx.rs.ResourceServer import ResourceServer
from iudx.rs.ResourceQuery import ResourceQuery
# entity id for the pune env aqm sensor.
entity_id = "datakaveri.org/04a15c9960ffda227e9546f3f46e629e1fe4132b/rs.iudx.org.in/pune-env-aqm/f36b4669-628b-ad93-9970-f9d424afbf75"
# creating an object of ResourceServer class using rs_url.
rs = ResourceServer(
rs_url="https://rs.iudx.org.in/ngsi-ld/v1",
headers={"content-type": "application/json"}
)
# creating a query for fetching latest data for the entity_id.
rs_query = ResourceQuery()
rs_entity = rs_query.add_entity(entity_id)
# create a during query for a time interval.
during_query = rs_entity.during_search(
start_time="2021-01-01T14:20:00Z",
end_time="2021-01-09T14:20:00Z"
)
# fetch results for the list of during queries.
results = rs.get_data([during_query])
# printing results
print(f"RESULTS: {results[0].results}") # get the result data of the resource query.
print(f"STATUS: {results[0].type}") # get the status code for the response.- Get the data for the specific entity and download the generated pandas.dataframe as a .CSV zipped file.
from iudx.entity.Entity import Entity
# entity id for the pune env aqm sensor.
entity_id = "datakaveri.org/04a15c9960ffda227e9546f3f46e629e1fe4132b/rs.iudx.org.in/pune-env-aqm/f36b4669-628b-ad93-9970-f9d424afbf75"
# Creating an entity for the sensor.
entity = Entity(entity_id)
# create a during query for a time interval.
df = entity.during_search(
start_time="2021-01-01T14:20:00Z",
end_time="2021-01-09T14:20:00Z"
)
display(df.head())
# To download the dataset
file_name = "IUDX_data" # custom name of the file
file_type = "csv" # can be CSV or JSON
# download method for saving data to zip file.
entity.download(file_name=file_name)- Get the token for accessing private resources using either Authorization token or clientId/clientSecret.
from iudx.auth.Token import Token
# Create a Token object with authorization token.
token = Token(auth_url="https://authorization.iudx.org.in/auth/v1/token", authorization_token=auth_token) # Keycloak issued token "Bearer <JWT>"
# Create a Token object with token file.
# token = Token(token_file=toke_file_path) # Keycloak issued token
# Create a Token object with client id and client secret.
# token = Token(client_id=client_id, client_secret=client_secret)
# Item id for the varanasi env aqm sensor.
item_id = "varanasismartcity.gov.in/62d1f729edd3d2a1a090cb1c6c89356296963d55/rs.iudx.org.in/varanasi-env-aqm"
# Set a private resource to access.
token.set_item(
item_id=item_id,
item_type="resource_group",
role="consumer") # Role of the user.
# Get access token for the private resource.
access_token = token.request_token()- Get the during data for specific entity id.
from iudx.misc.iudxe2ee import EncryptedResourceServer
from iudx.rs.ResourceServer import ResourceServer
from iudx.rs.ResourceQuery import ResourceQuery
# entity id for the pune env aqm sensor.
entity_id = "datakaveri.org/04a15c9960ffda227e9546f3f46e629e1fe4132b/rs.iudx.org.in/pune-env-aqm/f36b4669-628b-ad93-9970-f9d424afbf75"
# creating an object of ResourceServer class using rs_url.
ers = EncryptedResourceServer(
rs_url="https://rs.iudx.org.in/ngsi-ld/v1",
headers={"content-type": "application/json"}
)
# creating a query for fetching latest data for the entity_id.
rs_query = ResourceQuery()
rs_entity = rs_query.add_entity(entity_id)
# fetch results for a list of entities.
results = ers.get_latest([rs_entity])
# printing results
print(f"RESULTS: {results[0].results}") # get the result data of the resource query.
print(f"STATUS: {results[0].type}") # get the status code for the response.- Get the during data for specific entity id.
from iudx.misc.iudxe2ee import EncryptedResourceServer
from iudx.rs.ResourceServer import ResourceServer
from iudx.rs.ResourceQuery import ResourceQuery
# entity id for the pune env aqm sensor.
entity_id = "datakaveri.org/04a15c9960ffda227e9546f3f46e629e1fe4132b/rs.iudx.org.in/pune-env-aqm/f36b4669-628b-ad93-9970-f9d424afbf75"
# creating an object of ResourceServer class using rs_url.
rs = EncryptedResourceServer(
rs_url="https://rs.iudx.org.in/ngsi-ld/v1",
headers={"content-type": "application/json"}
)
# creating a query for fetching latest data for the entity_id.
rs_query = ResourceQuery()
rs_entity = rs_query.add_entity(entity_id)
# create a during query for a time interval.
during_query = rs_entity.during_search(
start_time="2021-01-01T14:20:00Z",
end_time="2021-01-09T14:20:00Z"
)
# fetch results for the list of during queries.
results = rs.get_data([during_query])
# printing results
print(f"RESULTS: {results[0].results}") # get the result data of the resource query.
print(f"STATUS: {results[0].type}") # get the status code for the response.For all of the cli commands, you can optionally pass Catalogue, Auth and Resource Server endpoints, if left empty, it will default to the IUDX cetral services
iudx
--cat_url=https://cos.iudx.org.in/iudx/cat/v1/
--rs_url=https://rs.iudx.org.in/iudx/cat/v1/
--auth_url=https://cos.iudx.org.in/auth/v1/
iudx
--entity <entity_id>
--meta
# Example
iudx --entity datakaveri.org/04a15c9960ffda227e9546f3f46e629e1fe4132b/rs.iudx.org.in/pune-env-aqm/f36b4669-628b-ad93-9970-f9d424afbf75 --meta
# Sample command
iudx
--entity <entity_id>
--token <token_id> (only for private resources which requires auth)
--start <start_timestamp>
--end <end_timestamp>
--download <file_name>
--type <file_type_csv_or_json>
# Example
iudx --entity datakaveri.org/04a15c9960ffda227e9546f3f46e629e1fe4132b/rs.iudx.org.in/pune-env-aqm/f36b4669-628b-ad93-9970-f9d424afbf75 --start 2021-01-01T14:20:00Z --end 2021-01-07T14:20:00Z --download test_file --type csv
# Sample command
iudx
--entity <entity_id>
--clientid <clientID>
--secret <clientSecret>
--latest
# Example Temporal
iudx --entity suratmunicipal.org/6db486cb4f720e8585ba1f45a931c63c25dbbbda/rs.iudx.org.in/surat-itms-realtime-info/surat-itms-live-eta --clientid=<clientID> --secret=<clientSecret> --entity-type=resource --role=consumer --start 2021-01-01T14:20:00Z --end 2021-01-09T14:20:00Z --download=sample --type=json
# Example static data (no --start and --end)
iudx --entity varanasismartcity.gov.in/62d1f729edd3d2a1a090cb1c6c89356296963d55/rs.iudx.org.in/varanasi-point-of-interests/smartpole-locations --clientid=<clientID> --secret=<clientSecret> --entity-type=resource --role=consumer --download=test --type=csv
NOTE: --clientid --secret is required for the all entities (open and secure). To obtain this, register on https://catalogue.iudx.org.in/
Use: iudx --help to know more about all possible options.
Further documentation on low level apis and their usage can be found here. Docs
The Tests directory and the examples directory contain further usage examples. Examples.