Add Progress Option

[SellersEvan]

I am working on a project that utilized rio-cogeo and we needed to be able to get the progress of a conversion. I thought other people might also have this issue. Basically, what this new feature allows you to do is set a TextIO output (like sys.stdout) to output the progress as a percentage to (and just the percentage). This would allow something else to read this TextIO to get the percentage that the conversion is at. This can be extremely useful to allow developers to check the progress of an update.

Let me know if you have any questions.

[SellersEvan]

@vincentsarago Does this look something the team would be interested in?

[vincentsarago]

sorry @SellersEvan I was busy on other projects.

To be honest the proposed solution might be a bit too complex at the moment, especially that you're calling 4 times updateProgress with the same percent.

would an option to overwrite fout

rio-cogeo/rio_cogeo/cogeo.py

Line 304 in f9ea9b9

fout = ctx.enter_context(open(os.devnull, "w")) if quiet else sys.stderr

be possible?

[vincentsarago]

worth noting that the percentage here does not reflect the status of the COG translation but only the reading part

[SellersEvan]

@vincentsarago

I removed the code complexity from the last update and instead opted to override the fout like you suggested. This adds some complexity to using it because Click will only output the progress if the output file is interactive, like a terminal. This can be hacked however, by overriding the text buffers isatty method to always return true - this is documented in the API examples.

Thoughts?

[vincentsarago]

I don't think we should use quiet for both.

we can add another option (name tbd)

[SellersEvan]

We can keep quite as it was before and add a new option maybe called progress or progress_out. I image the logic being like this...

fout = ctx.enter_context(open(os.devnull, "w")) if quiet else sys.stderr
if quiet is False and progress_out:
    fout = progress_out

[SellersEvan]

Implemented. Ready for review.