i.eodag: add i.eodag module

[HamedElgizery]

Adding i.eodag addon module. The module can be used for downloading different imagery datasets e.g. Landsat, Sentinel, and MODIS. EODAG [1] provides a single API interface to request imagery datasets from a number of different providers.

[1] https://eodag.readthedocs.io/en/stable/index.html

[ninsbl]

Some first comments. Very good start, Hamed.

@wenzeslaus Is it OK if we use a draft PR for technical GSoC discussions, Or should we have such discussions at a different place for now?

[veroandreo]

Thanks @HamedElgizery! I haven't tested yet, but some general comments:

• the .gitignore should not be part of the PR
• the html only includes the following sections: Description, Examples, See also, Author, all the rest is added by the parser from the code (the .py file in this case). Check the html file in i.landsat.download or i.sentinel.download for guidance

[wenzeslaus]

@wenzeslaus Is it OK if we use a draft PR for technical GSoC discussions, Or should we have such discussions at a different place for now?

Draft PR is appropriate. A great place to have a discussion over specific code!

[ninsbl]

Nice. It is taking shape. Please run pylint on your code to get some more hints on code formatting...

[ninsbl]

BTW, if searching does not require credentials, it would be good to add a basic unit-test for searching...

[HamedElgizery]

BTW, if searching does not require credentials, it would be good to add a basic unit-test for searching...

Most of the providers doesn't requirer credentials for searching, while others require credentials... So, if the user set a specific provider for searching (e.g. provider=usgs). If usgs requires credentials, then eodag will attempt to search using a different provider, if it didn't find the usgs credentials...

So, I think we could leave it for eodag to handle it, and just send a warning if the credentials are not there for that specified provider.

Something along the lines of:
"Credentials for {provider} was not found... Searching might be automatically rerouted to a different provider."

What do you think?

[ninsbl]

(...) So, I think we could leave it for eodag to handle it, and just send a warning if the credentials are not there for that specified provider. (...)
What do you think?

Sounds convinceing. We should then make sure in the module logic that the provider is not a required option (and consider potential consequences, e.g. lines 193, 199, ...)...

[HamedElgizery]

After a second thought, I think making the provider required by the user would constraint the behavior of the library better, and only searching in that provider. By that I mean, preventing eodag from automatically rerouting the searching process to a different provider, and instead it just terminates with a relevant error message or "0 results found", when the searching fails for the given provider.

That will make it more convenient when using it inside the other modules e.g. i.landsat.download & i.sentinel.download.

We can also provide a method for the user to see which providers have the datasets they are looking for... and then they can use one of these to search for the intended product.

Nevertheless, we could add a search feature without setting the "provider" later on.

[ninsbl]

After a second thought, I think making the provider required by the user would constraint the behavior of the library better,

Agreed, Also, by requesting a specific provider I would expect results to be more reliable. Anyway, you may also consider allowing multiple input (comma separated list) in the providers option... (which is probably a solution inbetween).

[veroandreo]

I just left some comments on the html file. I think we can merge after those are solved.

[HamedElgizery]

Thanks for the comments, @veroandreo . I will fix them ASAP.

[veroandreo]

I think this first version is ready to merge

[ninsbl]

Taking the liberty to merge this first version. Further improvements can be discussed in new PRs.

[ninsbl]

Congrats to your first contributed module, @HamedElgizery !

[HamedElgizery]

Congrats to your first contributed module, @HamedElgizery !

Thanks @ninsbl, and thank you all for the help!