[ ] I have already submitted an issue or discussion thread to discuss my idea with the maintainers.
What kind of change does this PR introduce? (check at least one)
[ ] Bugfix
[x] Feature
[ ] Documentation
[ ] Tutorial
[ ] Code style update
[x] Refactor
[ ] Build-related changes
[ ] Other, please describe:
Does this PR introduce a breaking change? (check one)
[x] Yes
[ ] No
Breaking changes summary:
base_dir, username and password arguments are removed in many functions. The information is directly retrieved from the config file.
Introduction of the protocol argument (valid values are ["local", "pps", "gesdisc"])
find_pps_filepaths, and find_disk_filepaths are removed. Created find_filepaths(protocol, ...)
Private functions in gpm_api.io.download.py, gpm_api.io.disk.py, gpm_api.io.pps.py have been renamed and modified
The gpm_api.io.directories.py module has been removed (and the content split into pps.py and disk.py)
The PR fulfills these requirements:
[x] It's submitted to the branch named as follow :
Fix a bug: bugfix-<some_key>-<word>
Improve the doc: doc-<some_key>-<word>
Improve a tutorial tutorial-<some_key>-<word>
Add a new feature: feature-<some_key>-<word>
Refactor some code: refactor-<some_key>-<word>
Optimize some code: optimize-<some_key>-<word>
[ ] When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)
[ ] Don't forget to link PR to issue if you are solving one.
[ ] All tests are passing.
[ ] New/updated tests are included
Summary
This refactor provide cleaner internals and enable to implement multiple options for data download.
The current implementation allow retrievals from PPS and GES DISC servers.
Prework
What kind of change does this PR introduce? (check at least one)
Does this PR introduce a breaking change? (check one)
Breaking changes summary:
base_dir,usernameandpasswordarguments are removed in many functions. The information is directly retrieved from the config file.protocolargument (valid values are ["local", "pps", "gesdisc"])find_pps_filepaths, andfind_disk_filepathsare removed. Createdfind_filepaths(protocol, ...)gpm_api.io.download.py,gpm_api.io.disk.py,gpm_api.io.pps.pyhave been renamed and modifiedgpm_api.io.directories.pymodule has been removed (and the content split intopps.pyanddisk.py)The PR fulfills these requirements:
bugfix-<some_key>-<word>doc-<some_key>-<word>tutorial-<some_key>-<word>feature-<some_key>-<word>refactor-<some_key>-<word>optimize-<some_key>-<word>fix #xxx[,#xxx], where "xxx" is the issue number)Summary
This refactor provide cleaner internals and enable to implement multiple options for data download. The current implementation allow retrievals from PPS and GES DISC servers.