Skip to content

Instantly share code, notes, and snippets.

@plant99

plant99/vendoring.md

Created March 21, 2021 08:27
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save plant99/0870cddb36cc20dafc5e0d70df56756f to your computer and use it in GitHub Desktop.
Save plant99/0870cddb36cc20dafc5e0d70df56756f to your computer and use it in GitHub Desktop.
Download ZIP
Vendoring in felicette
Raw
vendoring.md

Introduction

Vendoring is often considered an anti-pattern, for many reasons including the following

  • extra source code space
  • hard to track upstream changes
  • loss of version control information.

But sometimes one has to counter an anti-pattern with a relatively safer anti-pattern.

The problem

I once faced an issue where a project I was working on depended on GDAL, python bindings of which had to manually be added to $PYTHONPATH in some cases, and rio-color which primarily exposed a command-line interface.

Now, one could get them working with os.system('{command}') but I had very less context on how securely gdal, rio-color, or rio-mucho (an internal dependency of rio-color) managed memory or processes.

So using os.system was risky and would be hard for someone to debug if there'd be issues.

The solution

With some extra work, i.e to look into GDAL's pansharpening binding script, and rio-color's cli interface I collected the necessary clients and put them in felicette/utils/.

  • gdal_pansharpen function calls osgeo.gdal internally, and takes the same argument as one would use with a CLI.
  • Since the project was to be used only for color correction, rio-color/scripts/cli.py was stripped and a shorter version is maintained here.

These vendored clients are used in the following places respectively.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment