[gdal-dev] gdal-utils: About GDAL Python Utilities

[Matt.Wilkie at yukon.ca]

Hi,

I had to read through RFC 78: gdal-utils package<https://gdal.org/development/rfc/rfc78_gdal_utils_package.html> a few times to wrap my head around what the major components are. Here's some writing of what I think I understand. Is it correct?

About GDAL Python Utilities

The GDAL python utilities are included with GDAL. If you've installed GDAL you already have them. However you may want to use a newer or older version of the utilities without changing GDAL. This is where gdal-utils comes in.

gdal-utils: is the Gdal Python Utilities distribution. This is what you install. It's home page is https://pypi.org/project/gdal-utils/ . Install it with `pip install gdal-utils` and it will up or downgrade the utilities in place.

osgeo_utils: is the python package. This is what you use in your code after installing, e.g. `from osgeo_utils import ...`. If you're not writing code, ignore it.

(something here, perhaps names links to the utilities that are available on command line)

Developers

Clone or download the gdal project: https://github.com/OSGeo/gdal/

Osgeo_utils doesn't have a top level document yet. It's code root is .../swig/python/gdal-utils/osgeo_utils<https://github.com/OSGeo/gdal/tree/master/swig/python/gdal-utils/osgeo_utils> . It is nested inside the gdal-utils project. In your IDE set gdal-utils as the root folder.

(not sure about this. Is better to have osgeo_utils as root?)

Discuss via gdal-dev mailing list<https://lists.osgeo.org/mailman/listinfo/gdal-dev>.

Contribute changes with Pull Requests<https://github.com/OSGeo/gdal/pulls> from your fork to main GDAL project (and use gdal-utils label?)


Perhaps this could serve as part of a 'gdal-utils' project intro page somewhere. I think I still have write permissions to the Trac Wiki, but is that doesn't feel like the right place to me.

(BW, the Nabble archive links are broken on the RFC page.)

Matt Wilkie
Geomatics Developer & Administrator
Environment | Technology, Innovation and Mapping
T 867-667-8133 | Yukon.ca<http://yukon.ca/>
Hours: 08:30-16:30, Mon-Wed: Office, Thu: Remote, Fri: Away.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/gdal-dev/attachments/20220201/82f0d847/attachment.html>