Environmental data retrieval API query parser
Project description
OGC Environmental Data Retrieval Query Parser
The OGC API Environmental Data Retrieval query parser makes it easy to parse and use the API query.
Install
pip install edr-query-parser
Usage
EDR Collection Name Example
from edr_query_parser import EDRQueryParser
edr_query = EDRQueryParser('https://somewhere.com/collections/my_collection/position?parameter-name=param1,param2&coords=POINT(57.819 '
'-3.966)&datetime=2019-09-07T15:50-04:00/2019-09-07T15:50-05:00&f=geoJSON&crs=84&z=500/400')
print(edr_query.collection_name) #my_collection
EDR Query Type Example
from edr_query_parser import EDRQueryParser
edr_query = EDRQueryParser('https://somewhere.com/collections/my_collection/position?parameter-name=param1,param2&coords=POINT(57.819 '
'-3.966)&datetime=2019-09-07T15:50-04:00/2019-09-07T15:50-05:00&f=geoJSON&crs=84&z=500/400')
if edr_query.is_instances:
print(edr_query.instances_id)
else:
print(edr_query.query_type.is_position) # True
print(edr_query.query_type.is_radius) # False
print(edr_query.query_type.value) # position
EDR location ID Example
from edr_query_parser import EDRQueryParser
edr_query = EDRQueryParser('https://somewhere.com/collections/my_collection/locations/aberdeen?parameter-name='
'param1,param2&datetime=2019-09-07T15:50-04:00/2019-09-07T15:50-05:00&f=geoJSON&crs=84&z=500/400')
if edr_query.is_locations:
print(edr_query.locations_id) #aberdeen
EDR coords Example
The EDR query parser returns a WKT object
from edr_query_parser import EDRQueryParser
edr_query = EDRQueryParser('https://somewhere.com/collections/my_collection/position?coords=POINT(57.819 '
'-3.966)&datetime=2019-09-07T15:50-04:00/2019-09-07T15:50-05:00¶meter-name=parameter1,'
'parameter2&f=geoJSON&crs=84&z=all')
if edr_query.coords.is_set:
print(edr_query.coords.coords_type) # Point
if edr_query.coords.coords_type == 'Point':
print(edr_query.coords.coordinates[0]) # 57.819
print(edr_query.coords.coordinates[1]) # -3.966
EDR parameter-name Example
from edr_query_parser import EDRQueryParser
edr_query = EDRQueryParser('https://somewhere.com/collections/my_collection/position?coords=POINT(57.819 '
'-3.966)&datetime=2019-09-07T15:50-04:00/2019-09-07T15:50-05:00¶meter-name=parameter1,'
'parameter2&f=geoJSON&crs=84&z=all')
if edr_query.parameter_name.is_set:
print(edr_query.parameter_name.list) # [parameter1, parameter2]
EDR datetime Example
The EDR query parser returns a dateutil object
from edr_query_parser import EDRQueryParser
edr_query = EDRQueryParser('https://somewhere.com/collections/my_collection/position?coords=POINT(57.819 '
'-3.966)&datetime=2019-09-07T15:50-04:00/2019-09-07T15:50-05:00¶meter-name=parameter1,'
'parameter2&f=geoJSON&crs=84&z=all')
if edr_query.datetime.is_set:
if edr_query.datetime.is_interval:
print(edr_query.datetime.interval_from.timestamp(), edr_query.datetime.interval_to.timestamp())
elif edr_query.datetime.is_greater_than:
print(edr_query.datetime.interval_to.timestamp())
elif edr_query.datetime.is_less_than:
print(edr_query.datetime.interval_from.timestamp())
else:
print(edr_query.datetime.exact.timestamp())
EDR f Parameter Example
from edr_query_parser import EDRQueryParser
edr_query = EDRQueryParser('https://somewhere.com/collections/my_collection/position?parameter-name=param1,param2&coords=POINT(57.819 '
'-3.966)&datetime=2019-09-07T15:50-04:00/2019-09-07T15:50-05:00&f=geoJSON&crs=84&z=500/400')
print(edr_query.format.value) # geoJSON
EDR z Parameter Example
from edr_query_parser import EDRQueryParser
edr_query = EDRQueryParser('https://somewhere.com/collections/my_collection/position?coords=POINT(57.819 '
'-3.966)&datetime=2019-09-07T15:50-04:00/2019-09-07T15:50-05:00¶meter-name=parameter1,'
'parameter2&f=geoJSON&crs=84&z=12/240')
if edr_query.z.is_set:
if edr_query.z.is_interval:
print(edr_query.z.interval_from, edr_query.z.interval_to)
if edr_query.z.is_list:
print(edr_query.z.interval_from, edr_query.z.list)
EDR crs Parameter Example
from edr_query_parser import EDRQueryParser
edr_query = EDRQueryParser('https://somewhere.com/collections/my_collection/position?coords=POINT(57.819 '
'-3.966)&datetime=2019-09-07T15:50-04:00/2019-09-07T15:50-05:00¶meter-name=parameter1,'
'parameter2&f=geoJSON&crs=84&z=12/240')
print(edr_query.crs.value) # 84
EDR bbox Parameter Example
from edr_query_parser import EDRQueryParser
edr_query = EDRQueryParser('https://somewhere.com/collections/my_collection/items/some_item/?bbox=12,13,20,21')
print(edr_query.bbox.list) # [12.0, 13.0, 20.0, 21.0]
EDR Pagination Limit Parameter Example
from edr_query_parser import EDRQueryParser
edr_query = EDRQueryParser('https://somewhere.com/collections/my_collection/items?limit=100')
print(edr_query.limit.value) # 100
EDR Pagination Next Parameter Example
from edr_query_parser import EDRQueryParser
edr_query = EDRQueryParser('https://somewhere.com/collections/my_collection/items?next=token123')
print(edr_query.next.value) # "token123"
EDR Parameter Example
from edr_query_parser import EDRQueryParser
edr_query = EDRQueryParser('https://somewhere.com/collections/my_collection/items?next=token123')
print(edr_query.next.value) # "token123"
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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for edr_query_parser-3.2.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9c6c082ac08ad3d7817d97164de6ecfe08042ae904dd9941b289773353eae12 |
|
MD5 | 036729613ab558a46f3c71dbc2404b85 |
|
BLAKE2b-256 | 8e6fd773ce282ed9eae6dc42f870ea7345175ed3ea6d079d2d153205964cdfa7 |