pyrosm.recipes.validate

pyrosm.recipes.validate(path)

Check a recipe file without running it and return it resolved.

Every section is checked eagerly: the keys, the area, the input files (they must exist; a PBF must start with an OSM header), every keyword against the function it is passed to, and the output paths, which must be relative, portable and named once. Raises ValueError naming the key that is wrong, or ImportError when PyYAML is missing.

Parameters:

path (str | pathlib.Path) – The recipe YAML file.

Returns:

The resolved recipe: recipe_path, recipe_dir, version, extract, pbf, reader, layers, graph and outputs.

Return type:

dict