<div dir="ltr">Hi Matt,<div><br></div><div>Thanks for looking into this.</div><div><br></div><div>Yes, you got it right. </div><div>You can find some documentation in the following pages, though it certainly could be approved as per your suggestions, maybe also by using some text from the RFC.</div><div><a href="https://gdal.org/api/index.html#python-api">https://gdal.org/api/index.html#python-api</a><br></div><div><a href="https://gdal.org/programs/index.html#programs">https://gdal.org/programs/index.html#programs</a> (note the programs that end with .py)<br></div><div><a href="https://gdal.org/api/python_samples.html">https://gdal.org/api/python_samples.html</a><br></div><div>These doc pages are auto generated from the sources here:</div><div><a href="https://github.com/OSGeo/gdal/tree/master/doc/source">https://github.com/OSGeo/gdal/tree/master/doc/source</a><br></div><div><br></div><div>> Osgeo_utils doesn’t have a top level document yet.<br></div><div>I'm not sure what you mean by a top level document (it doesn't have its own separate repository if that is what you meant).</div><div><br></div><div>> It’s code root is <a href="https://github.com/OSGeo/gdal/tree/master/swig/python/gdal-utils/osgeo_utils" target="_blank">.../swig/python/gdal-utils/osgeo_utils</a> . It is nested inside the gdal-utils project. In your IDE set gdal-utils as the root folder. (<i>not sure about this. Is it better to have osgeo_utils as root?)</i></div><div>In order to make python use the package without installing it you need to add its parent folder (that is <a href="https://github.com/OSGeo/gdal/tree/master/swig/python/gdal-utils/osgeo_utils" target="_blank">.../swig/python/gdal-utils/</a> ) as a source dir), which practically inserts that folder at the top of your `sys.path`, which is where python looks for packages when you import. So because your `site-packages` folder is in your `sys.path` by default, then any package under it is recognized. </div><div>When you insert any other folder before it then it gets a higher priority (and that is what happens when you mark as source dir).</div><div><br></div><div>> Contribute changes with <a href="https://github.com/OSGeo/gdal/pulls" target="_blank">Pull Requests</a> from your fork to the main GDAL project <i>(and use gdal-utils label?)</i></div><div>Right, A dedicated label sounds like a good idea. </div><div><br></div><div>Please feel free to make a PR to improve the above docs by editing the RST pages (<a href="https://github.com/OSGeo/gdal/tree/master/doc/source">https://github.com/OSGeo/gdal/tree/master/doc/source</a>).</div><div>Feel free to ask further questions.</div><div><br></div><div>Idan.</div><div><br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, 1 Feb 2022 at 20:51, <<a href="mailto:Matt.Wilkie@yukon.ca">Matt.Wilkie@yukon.ca</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<div lang="EN-CA">
<div class="gmail-m_-692581159252996356WordSection1">
<p class="MsoNormal">Hi,<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">I had to read through <b><a href="https://gdal.org/development/rfc/rfc78_gdal_utils_package.html" target="_blank">RFC 78: gdal-utils package</a></b> 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?<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<h2 style="margin-left:36pt">About GDAL Python Utilities<span style="color:windowtext"><u></u><u></u></span></h2>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal" style="margin-left:36pt">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
<b>gdal-utils</b> comes in.<u></u><u></u></p>
<p class="MsoNormal" style="margin-left:36pt"><u></u> <u></u></p>
<p class="MsoNormal" style="margin-left:36pt"><b>gdal-utils</b>: is the Gdal Python Utilities
<i>distribution</i>. This is what you install. It’s home page is <a href="https://pypi.org/project/gdal-utils/" target="_blank">
https://pypi.org/project/gdal-utils/</a> . Install it with `pip install gdal-utils` and it will up or downgrade the utilities in place.<u></u><u></u></p>
<p class="MsoNormal" style="margin-left:36pt"><u></u> <u></u></p>
<p class="MsoNormal" style="margin-left:36pt"><b>osgeo_utils</b>:<b> </b>is the python
<i>package</i>. This is what you use in your code after installing, e.g. `from osgeo_utils import ...`. If you’re not writing code, ignore it.
<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal" style="margin-left:36pt"><i>(something here, perhaps names links to the utilities that are available on command line)<u></u><u></u></i></p>
<p class="MsoNormal"><u></u> <u></u></p>
<h3 style="margin-left:36pt">Developers<u></u><u></u></h3>
<p class="MsoNormal" style="margin-left:36pt"><u></u> <u></u></p>
<p class="MsoNormal" style="margin-left:36pt">Clone or download the gdal project:
<a href="https://github.com/OSGeo/gdal/" target="_blank">https://github.com/OSGeo/gdal/</a><u></u><u></u></p>
<p class="MsoNormal" style="margin-left:36pt"><u></u> <u></u></p>
<p class="MsoNormal" style="margin-left:36pt">Osgeo_utils doesn’t have a top level document yet. It’s code root is
<a href="https://github.com/OSGeo/gdal/tree/master/swig/python/gdal-utils/osgeo_utils" target="_blank">
.../swig/python/gdal-utils/osgeo_utils</a> . It is nested inside the gdal-utils project. In your IDE set gdal-utils as the root folder.<u></u><u></u></p>
<p class="MsoNormal" style="margin-left:36pt"><u></u> <u></u></p>
<p class="MsoNormal" style="margin-left:36pt">(<i>not sure about this. Is better to have osgeo_utils as root?)<u></u><u></u></i></p>
<p class="MsoNormal" style="margin-left:36pt"><i><u></u> <u></u></i></p>
<p class="MsoNormal" style="margin-left:36pt">Discuss via <a href="https://lists.osgeo.org/mailman/listinfo/gdal-dev" target="_blank">
gdal-dev mailing list</a>.<u></u><u></u></p>
<p class="MsoNormal" style="margin-left:36pt"><u></u> <u></u></p>
<p class="MsoNormal" style="margin-left:36pt">Contribute changes with <a href="https://github.com/OSGeo/gdal/pulls" target="_blank">
Pull Requests</a> from your fork to main GDAL project <i>(and use gdal-utils label?)<u></u><u></u></i></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">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.
<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">(BW, the Nabble archive links are broken on the RFC page.)<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal" style="margin-top:4pt;line-height:115%;vertical-align:middle">
<b><span lang="EN-US" style="font-size:10pt;line-height:115%">Matt Wilkie</span></b><span lang="EN-US" style="font-size:10pt;line-height:115%"><u></u><u></u></span></p>
<p class="MsoNormal"><span lang="EN-US" style="font-size:10pt">Geomatics Developer & Administrator<u></u><u></u></span></p>
<p class="MsoNormal"><span lang="EN-US" style="font-size:10pt">Environment
<span style="color:rgb(46,116,181)">|</span> Technology, Innovation and Mapping<u></u><u></u></span></p>
<p class="MsoNormal"><span lang="EN-US" style="font-size:10pt">T 867-667-8133
<span style="color:rgb(46,116,181)">|</span> </span><u><span style="font-size:10pt"><a href="http://yukon.ca/" target="_blank"><span lang="EN-US" style="color:windowtext">Yukon.ca</span></a><u></u><u></u></span></u></p>
<p class="MsoNormal"><i><span style="font-size:10pt">Hours: 08:30-16:30, Mon-Wed: Office, Thu: Remote, Fri: Away.<u></u><u></u></span></i></p>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
</div>
_______________________________________________<br>
gdal-dev mailing list<br>
<a href="mailto:gdal-dev@lists.osgeo.org" target="_blank">gdal-dev@lists.osgeo.org</a><br>
<a href="https://lists.osgeo.org/mailman/listinfo/gdal-dev" rel="noreferrer" target="_blank">https://lists.osgeo.org/mailman/listinfo/gdal-dev</a><br>
</blockquote></div>