Module functions.tools.perimeter_search

Functions

def perimeter_search(datasetName, facettes, exclusion_country_code, geofilter_distance, geofilter_polygon, output_path, rows=-1, output_path_file='zip_perimeter.csv', verbose=False)

creates a csv with Zip-Codes in a perimeter from a opendatasoft API Call

Args

datasetName : str

Name of the Dataset to use from the opendatasoft API

facettes : str

Facettes (fields) to get from the API Call

exclusion_country_code : str

Country Codes to exclude

geofilter_distance : str

coordinate North, coordinates East, distance in metres as a query string, \

example

"47.5596%2C7.5886%2C{distance}

geofilter_polygon : str

2d polygon of coordinates in WGS84 format eg. a shape file, example:"(47.351454435569536,8.565216064453125),(47.58354293895587,8.51509094238281),(47.57057306743187,8.953857421875),(47.34819792163414,9.026641845703123),(47.351919635443565,8.568649291992186),(47.351454435569536,8.565216064453125)"

output_path : str

path to save the csv to

rows : int

count of rows to return (they are limited to 10000, use -1 for 10000)

output_path_file : str

file name for the csv file , default is: zip_perimeter.csv

verbose : bool

if true prints the received records