gjf: A tool for fixing invalid GeoJSON objects
The goal of this tool is to make it as easy as possible to fix invalid GeoJSON objects through Python or Command Line.
Installation
pip install gjf
Verify installation by running
gjf --version
Features
- Fix all types of GeoJSON objects, including FeatureCollection and Geometry Collection. If there is nothing to fix the object will be returned as is.
- Can validate GeoJSON objects, and print explanations if the object is not valid.
- Can be used within Python or command line
Usage
Python
Say, you have a GeoJSON object defined as follows:
obj = {"type":"Polygon","coordinates":[[[45.892166,25.697688],[45.894522,25.696483],[45.897131,25.695144],[45.898814,25.694268],[45.900496,25.693394],[45.901284,25.692983],[45.903946,25.697312],[45.894791,25.701933],[45.894621,25.701657],[45.892593,25.698379],[45.892166,25.697688]],[[45.892086,25.697729],[45.892166,25.697688],[45.892086,25.697729]]]}
You can simply call apply_fixes_if_needed
from gjf.geojson_fixer import apply_fixes_if_needed
fixed_obj = apply_fixes_if_needed(obj)
You can also flip coordinates order by toggling flip_coords
from gjf.geojson_fixer import apply_fixes_if_needed
fixed_obj_with_flipped_coordinates = apply_fixes_if_needed(obj, flip_coords=True)
You can also check whether a GeoJSON object is valid or not by calling validity
from gjf.geojson_fixer import validity
validity(obj)
Will result ('invalid', ['Too few points in geometry component[45.892086 25.697729]', ''])
CLI
gjf invalid.geojson
gjf will fix the file, and output to invalid_fixed.geojson by default. If you need the output directed in another way you can use --output-method as directed below. It is also possible to fix multiple files, as below.
gjf invalid_1.geojson invalid_2.geojson
Above will output fixed GeoJSON objects to invalid_1_fixed.geojson and invalid_2_fixed.geojson.
CLI Arguments
--versionprint version and exit--validatevalidate GeoJSON file, and print the error message if it is not valid, without attempting to fix it.--flipFlip coordinates order-o, --output-method [overwrite|new_file|print]- Default is
new_file, wheregjfwill output fixed GeoJSON object to file with the postfix_fixed. Whereasoverwritewill write the fixed GeoJSON object to the source file, overwriting the original file in process. Lastly,printwill output the fixed GeoJSON object on the terminal
- Default is
gjf --output-method print invalid.geojson
This would print fixed invalid.geojson on the terminal
Issues
Feel free to open an issue if you have any problems.
6 Jan 4, 2023
114 Dec 21, 2022
87 Dec 14, 2022
32 Dec 29, 2022
73 Dec 24, 2022
20 Dec 10, 2022
2 Jan 11, 2022
3.4k Jan 2, 2023
26 Dec 26, 2022
4 Nov 25, 2022
765 Jan 6, 2023
77 Jul 26, 2022
1 Dec 19, 2021
996 Jan 1, 2023
7 Dec 13, 2021
1 Jan 13, 2022
567 Nov 30, 2022
12 Sep 27, 2022
142 Dec 30, 2022
1 Dec 26, 2021
111 Nov 15, 2022
53 Dec 29, 2022
0 Jan 20, 2022
183 Dec 29, 2022
3 Mar 22, 2022
837 Dec 28, 2022
46 Aug 16, 2022
2 Jan 10, 2022
342 Dec 31, 2022
747 Dec 19, 2022
1.4k Dec 30, 2022
6 Dec 01, 2021
70 Nov 18, 2022
4 Dec 15, 2022
2 Nov 17, 2022
38 Jan 03, 2023